AWS.Tools.SSMContacts.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SSMContacts</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SMC.AddSMCResourceTagCmdlet"> <summary> Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.AddSMCResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact or escalation plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.AddSMCResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tags that you are adding to the contact or escalation plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.AddSMCResourceTagCmdlet.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.SSMContacts.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.AddSMCResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.AddSMCResourceTagCmdlet.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.SMC.ConfirmSMCPageCmdlet"> <summary> Used to acknowledge an engagement to a contact channel during an incident. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.ConfirmSMCPageCmdlet.AcceptCode"> <summary> <para> <para>The accept code is a 6-digit code used to acknowledge the page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.ConfirmSMCPageCmdlet.AcceptType"> <summary> <para> <para>The type indicates if the page was <code>DELIVERED</code> or <code>READ</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.ConfirmSMCPageCmdlet.ContactChannelId"> <summary> <para> <para>The ARN of the contact channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.ConfirmSMCPageCmdlet.Note"> <summary> <para> <para>Information provided by the user when the user acknowledges the page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.ConfirmSMCPageCmdlet.PageId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the engagement to a contact channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.ConfirmSMCPageCmdlet.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.SSMContacts.Model.AcceptPageResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.ConfirmSMCPageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PageId parameter. The -PassThru parameter is deprecated, use -Select '^PageId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.ConfirmSMCPageCmdlet.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.SMC.DisableSMCContactChannelCmdlet"> <summary> To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.DisableSMCContactChannelCmdlet.ContactChannelId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact channel you're deactivating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.DisableSMCContactChannelCmdlet.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.SSMContacts.Model.DeactivateContactChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.DisableSMCContactChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactChannelId parameter. The -PassThru parameter is deprecated, use -Select '^ContactChannelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.DisableSMCContactChannelCmdlet.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.SMC.EnableSMCContactChannelCmdlet"> <summary> Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.EnableSMCContactChannelCmdlet.ActivationCode"> <summary> <para> <para>The code sent to the contact channel when it was created in the contact. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.EnableSMCContactChannelCmdlet.ContactChannelId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.EnableSMCContactChannelCmdlet.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.SSMContacts.Model.ActivateContactChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.EnableSMCContactChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactChannelId parameter. The -PassThru parameter is deprecated, use -Select '^ContactChannelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.EnableSMCContactChannelCmdlet.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.SMC.GetSMCContactCmdlet"> <summary> Retrieves information about the specified contact or escalation plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactCmdlet.ContactId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact or escalation plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.GetContactResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.GetContactResponse 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.SMC.GetSMCContactCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactId parameter. The -PassThru parameter is deprecated, use -Select '^ContactId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactChannelCmdlet"> <summary> List details about a specific contact channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactChannelCmdlet.ContactChannelId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact channel you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.GetContactChannelResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.GetContactChannelResponse 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.SMC.GetSMCContactChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactChannelId parameter. The -PassThru parameter is deprecated, use -Select '^ContactChannelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactChannelListCmdlet"> <summary> Lists all contact channels for the specified contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactChannelListCmdlet.ContactId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactChannelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of contact channels per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactChannelListCmdlet.NextToken"> <summary> <para> <para>The pagination token to continue to the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactChannelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactChannels'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.ListContactChannelsResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.ListContactChannelsResponse 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.SMC.GetSMCContactChannelListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactId parameter. The -PassThru parameter is deprecated, use -Select '^ContactId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactListCmdlet"> <summary> Lists all contacts and escalation plans in Incident Manager. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactListCmdlet.AliasPrefix"> <summary> <para> <para>Used to list only contacts who's aliases start with the specified prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactListCmdlet.Type"> <summary> <para> <para>The type of contact. A contact is type <code>PERSONAL</code> and an escalation plan is type <code>ESCALATION</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of contacts and escalation plans per page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactListCmdlet.NextToken"> <summary> <para> <para>The pagination token to continue to the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Contacts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.ListContactsResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.ListContactsResponse 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.SMC.GetSMCContactListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Type parameter. The -PassThru parameter is deprecated, use -Select '^Type' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactPolicyCmdlet"> <summary> Retrieves the resource policies attached to the specified contact or escalation plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactPolicyCmdlet.ContactArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact or escalation plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCContactPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.GetContactPolicyResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.GetContactPolicyResponse 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.SMC.GetSMCContactPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactArn parameter. The -PassThru parameter is deprecated, use -Select '^ContactArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.GetSMCEngagementCmdlet"> <summary> Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCEngagementCmdlet.EngagementId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the engagement you want the details of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCEngagementCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.DescribeEngagementResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.DescribeEngagementResponse 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.SMC.GetSMCEngagementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EngagementId parameter. The -PassThru parameter is deprecated, use -Select '^EngagementId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.GetSMCEngagementListCmdlet"> <summary> Lists all engagements that have happened in an incident. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCEngagementListCmdlet.TimeRangeValue_EndTime"> <summary> <para> <para>The end of the time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCEngagementListCmdlet.IncidentId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the incident you're listing engagements for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCEngagementListCmdlet.TimeRangeValue_StartTime"> <summary> <para> <para>The start of the time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCEngagementListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of engagements per page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCEngagementListCmdlet.NextToken"> <summary> <para> <para>The pagination token to continue to the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCEngagementListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Engagements'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.ListEngagementsResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.ListEngagementsResponse 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.SMC.GetSMCEngagementListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the IncidentId parameter. The -PassThru parameter is deprecated, use -Select '^IncidentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.GetSMCPageCmdlet"> <summary> Lists details of the engagement to a contact channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPageCmdlet.PageId"> <summary> <para> <para>The ID of the engagement to a contact channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.DescribePageResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.DescribePageResponse 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.SMC.GetSMCPageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PageId parameter. The -PassThru parameter is deprecated, use -Select '^PageId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.GetSMCPageReceiptListCmdlet"> <summary> Lists all of the engagements to contact channels that have been acknowledged. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPageReceiptListCmdlet.PageId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the engagement to a specific contact channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPageReceiptListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of acknowledgements per page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPageReceiptListCmdlet.NextToken"> <summary> <para> <para>The pagination token to continue to the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPageReceiptListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Receipts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.ListPageReceiptsResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.ListPageReceiptsResponse 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.SMC.GetSMCPageReceiptListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PageId parameter. The -PassThru parameter is deprecated, use -Select '^PageId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.GetSMCPagesByContactListCmdlet"> <summary> Lists the engagements to a contact's contact channels. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPagesByContactListCmdlet.ContactId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPagesByContactListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of engagements to contact channels to list per page of results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPagesByContactListCmdlet.NextToken"> <summary> <para> <para>The pagination token to continue to the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPagesByContactListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Pages'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.ListPagesByContactResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.ListPagesByContactResponse 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.SMC.GetSMCPagesByContactListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactId parameter. The -PassThru parameter is deprecated, use -Select '^ContactId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.GetSMCPagesByEngagementListCmdlet"> <summary> Lists the engagements to contact channels that occurred by engaging a contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPagesByEngagementListCmdlet.EngagementId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the engagement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPagesByEngagementListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of engagements to contact channels to list per page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPagesByEngagementListCmdlet.NextToken"> <summary> <para> <para>The pagination token to continue to the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCPagesByEngagementListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Pages'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.ListPagesByEngagementResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.ListPagesByEngagementResponse 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.SMC.GetSMCPagesByEngagementListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EngagementId parameter. The -PassThru parameter is deprecated, use -Select '^EngagementId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.GetSMCResourceTagCmdlet"> <summary> Lists the tags of an escalation plan or contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact or escalation plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCResourceTagCmdlet.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.SSMContacts.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.SSMContacts.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="P:Amazon.PowerShell.Cmdlets.SMC.GetSMCResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactCmdlet"> <summary> Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactCmdlet.Alias"> <summary> <para> <para>The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactCmdlet.DisplayName"> <summary> <para> <para>The full name of the contact or escalation plan. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactCmdlet.IdempotencyToken"> <summary> <para> <para>A token ensuring that the action is called only once with the specified details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactCmdlet.Plan_Stage"> <summary> <para> <para>A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactCmdlet.Tag"> <summary> <para> <para>Adds a tag to the target. You can only tag resources created in the first Region of your replication set. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactCmdlet.Type"> <summary> <para> <para>To create an escalation plan use <code>ESCALATION</code>. To create a contact use <code>PERSONAL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.CreateContactResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.CreateContactResponse 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.SMC.NewSMCContactCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Alias parameter. The -PassThru parameter is deprecated, use -Select '^Alias' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactCmdlet.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.SMC.NewSMCContactChannelCmdlet"> <summary> A contact channel is the method that Incident Manager uses to engage your contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactChannelCmdlet.ContactId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactChannelCmdlet.DeferActivation"> <summary> <para> <para>If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactChannelCmdlet.IdempotencyToken"> <summary> <para> <para>A token ensuring that the action is called only once with the specified details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactChannelCmdlet.Name"> <summary> <para> <para>The name of the contact channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactChannelCmdlet.DeliveryAddress_SimpleAddress"> <summary> <para> <para>The format is dependent on the type of the contact channel. The following are the expected formats:</para><ul><li><para>SMS - '+' followed by the country code and phone number</para></li><li><para>VOICE - '+' followed by the country code and phone number</para></li><li><para>EMAIL - any standard email format</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactChannelCmdlet.Type"> <summary> <para> <para>Incident Manager supports three types of contact channels:</para><ul><li><para><code>SMS</code></para></li><li><para><code>VOICE</code></para></li><li><para><code>EMAIL</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactChannelArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.CreateContactChannelResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.CreateContactChannelResponse 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.SMC.NewSMCContactChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactId parameter. The -PassThru parameter is deprecated, use -Select '^ContactId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.NewSMCContactChannelCmdlet.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.SMC.RemoveSMCContactCmdlet"> <summary> To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCContactCmdlet.ContactId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact that you're deleting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCContactCmdlet.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.SSMContacts.Model.DeleteContactResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCContactCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactId parameter. The -PassThru parameter is deprecated, use -Select '^ContactId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCContactCmdlet.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.SMC.RemoveSMCContactChannelCmdlet"> <summary> To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCContactChannelCmdlet.ContactChannelId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCContactChannelCmdlet.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.SSMContacts.Model.DeleteContactChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCContactChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactChannelId parameter. The -PassThru parameter is deprecated, use -Select '^ContactChannelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCContactChannelCmdlet.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.SMC.RemoveSMCResourceTagCmdlet"> <summary> Removes tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact or escalation plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCResourceTagCmdlet.TagKey"> <summary> <para> <para>The key of the tag that you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCResourceTagCmdlet.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.SSMContacts.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.RemoveSMCResourceTagCmdlet.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.SMC.SendSMCActivationCodeCmdlet"> <summary> Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the <code>ActivateChannel</code> action. Incident Manager can't engage a contact channel until it has been activated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.SendSMCActivationCodeCmdlet.ContactChannelId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.SendSMCActivationCodeCmdlet.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.SSMContacts.Model.SendActivationCodeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.SendSMCActivationCodeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactChannelId parameter. The -PassThru parameter is deprecated, use -Select '^ContactChannelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.SendSMCActivationCodeCmdlet.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.SMC.StartSMCEngagementCmdlet"> <summary> Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StartSMCEngagementCmdlet.ContactId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact being engaged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StartSMCEngagementCmdlet.Content"> <summary> <para> <para>The secure content of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> or <code>EMAIL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StartSMCEngagementCmdlet.IdempotencyToken"> <summary> <para> <para>A token ensuring that the action is called only once with the specified details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StartSMCEngagementCmdlet.IncidentId"> <summary> <para> <para>The ARN of the incident that the engagement is part of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StartSMCEngagementCmdlet.PublicContent"> <summary> <para> <para>The insecure content of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StartSMCEngagementCmdlet.PublicSubject"> <summary> <para> <para>The insecure subject of the message that was sent to the contact. Use this field for engagements to <code>SMS</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StartSMCEngagementCmdlet.Sender"> <summary> <para> <para>The user that started the engagement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StartSMCEngagementCmdlet.Subject"> <summary> <para> <para>The secure subject of the message that was sent to the contact. Use this field for engagements to <code>VOICE</code> or <code>EMAIL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StartSMCEngagementCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EngagementArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SSMContacts.Model.StartEngagementResponse). Specifying the name of a property of type Amazon.SSMContacts.Model.StartEngagementResponse 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.SMC.StartSMCEngagementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactId parameter. The -PassThru parameter is deprecated, use -Select '^ContactId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StartSMCEngagementCmdlet.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.SMC.StopSMCEngagementCmdlet"> <summary> Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StopSMCEngagementCmdlet.EngagementId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the engagement.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StopSMCEngagementCmdlet.Reason"> <summary> <para> <para>The reason that you're stopping the engagement. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StopSMCEngagementCmdlet.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.SSMContacts.Model.StopEngagementResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StopSMCEngagementCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EngagementId parameter. The -PassThru parameter is deprecated, use -Select '^EngagementId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.StopSMCEngagementCmdlet.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.SMC.UpdateSMCContactCmdlet"> <summary> Updates the contact or escalation plan specified. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactCmdlet.ContactId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactCmdlet.DisplayName"> <summary> <para> <para>The full name of the contact or escalation plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactCmdlet.Plan_Stage"> <summary> <para> <para>A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactCmdlet.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.SSMContacts.Model.UpdateContactResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactId parameter. The -PassThru parameter is deprecated, use -Select '^ContactId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactCmdlet.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.SMC.UpdateSMCContactChannelCmdlet"> <summary> Updates a contact's contact channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactChannelCmdlet.ContactChannelId"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact channel you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactChannelCmdlet.Name"> <summary> <para> <para>The name of the contact channel</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactChannelCmdlet.DeliveryAddress_SimpleAddress"> <summary> <para> <para>The format is dependent on the type of the contact channel. The following are the expected formats:</para><ul><li><para>SMS - '+' followed by the country code and phone number</para></li><li><para>VOICE - '+' followed by the country code and phone number</para></li><li><para>EMAIL - any standard email format</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactChannelCmdlet.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.SSMContacts.Model.UpdateContactChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactChannelId parameter. The -PassThru parameter is deprecated, use -Select '^ContactChannelId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.UpdateSMCContactChannelCmdlet.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.SMC.WriteSMCContactPolicyCmdlet"> <summary> Adds a resource to the specified contact or escalation plan. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.WriteSMCContactPolicyCmdlet.ContactArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the contact or escalation plan.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.WriteSMCContactPolicyCmdlet.Policy"> <summary> <para> <para>Details of the resource policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.WriteSMCContactPolicyCmdlet.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.SSMContacts.Model.PutContactPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.WriteSMCContactPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactArn parameter. The -PassThru parameter is deprecated, use -Select '^ContactArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SMC.WriteSMCContactPolicyCmdlet.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> |