AWS.Tools.NotificationsContacts.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.NotificationsContacts</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.UNC.AddUNCResourceTagCmdlet"> <summary> Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.AddUNCResourceTagCmdlet.Arn"> <summary> <para> <para>The ARN of the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.AddUNCResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tags to apply to the configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.AddUNCResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NotificationsContacts.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.AddUNCResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.UNC.EnableUNCEmailContactCmdlet"> <summary> Activates an email contact using an activation code. This code is in the activation email sent to the email address associated with this email contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.EnableUNCEmailContactCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.EnableUNCEmailContactCmdlet.Code"> <summary> <para> <para>The activation code for this email contact.</para><para>An email contact has a maximum of five activation attempts. Activation codes expire after 12 hours and are generated by the <a href="https://docs.aws.amazon.com/notificationscontacts/latest/APIReference/API_SendActivationCode.html">SendActivationCode</a> API action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.EnableUNCEmailContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NotificationsContacts.Model.ActivateEmailContactResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.EnableUNCEmailContactCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.UNC.GetUNCEmailContactCmdlet"> <summary> Returns an email contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.GetUNCEmailContactCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the email contact to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.GetUNCEmailContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EmailContact'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NotificationsContacts.Model.GetEmailContactResponse). Specifying the name of a property of type Amazon.NotificationsContacts.Model.GetEmailContactResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.UNC.GetUNCEmailContactListCmdlet"> <summary> Lists all email contacts created under the Account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.GetUNCEmailContactListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.GetUNCEmailContactListCmdlet.NextToken"> <summary> <para> <para>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.GetUNCEmailContactListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EmailContacts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NotificationsContacts.Model.ListEmailContactsResponse). Specifying the name of a property of type Amazon.NotificationsContacts.Model.ListEmailContactsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.GetUNCEmailContactListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.UNC.GetUNCResourceTagCmdlet"> <summary> Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.GetUNCResourceTagCmdlet.Arn"> <summary> <para> <para>The ARN you specified to list the tags of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.GetUNCResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NotificationsContacts.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.NotificationsContacts.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.UNC.NewUNCEmailContactCmdlet"> <summary> Creates an email contact for the provided email address. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.NewUNCEmailContactCmdlet.EmailAddress"> <summary> <para> <para>The email address this email contact points to. The activation email and any subscribed emails are sent here.</para><note><para>This email address can't receive emails until it's activated.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.NewUNCEmailContactCmdlet.Name"> <summary> <para> <para>The name of the email contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.NewUNCEmailContactCmdlet.Tag"> <summary> <para> <para>A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.NewUNCEmailContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NotificationsContacts.Model.CreateEmailContactResponse). Specifying the name of a property of type Amazon.NotificationsContacts.Model.CreateEmailContactResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.NewUNCEmailContactCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.UNC.RemoveUNCEmailContactCmdlet"> <summary> Deletes an email contact. <note><para> Deleting an email contact removes it from all associated notification configurations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.RemoveUNCEmailContactCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.RemoveUNCEmailContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NotificationsContacts.Model.DeleteEmailContactResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.RemoveUNCEmailContactCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.UNC.RemoveUNCResourceTagCmdlet"> <summary> Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts.. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.RemoveUNCResourceTagCmdlet.Arn"> <summary> <para> <para>The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.RemoveUNCResourceTagCmdlet.TagKey"> <summary> <para> <para>Specifies a list of tag keys that you want to remove from the specified resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.RemoveUNCResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NotificationsContacts.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.RemoveUNCResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.UNC.SendUNCActivationCodeCmdlet"> <summary> Sends an activation email to the email address associated with the specified email contact. <note><para> It might take a few minutes for the activation email to arrive. If it doesn't arrive, check in your spam folder or try sending another activation email. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.SendUNCActivationCodeCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.SendUNCActivationCodeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NotificationsContacts.Model.SendActivationCodeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.UNC.SendUNCActivationCodeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |