AWS.Tools.FMS.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>Add-FMSAdminAccountAssociation</name> <description> <para>Calls the Firewall Management Service AssociateAdminAccount API operation.</para> </description> <verb>Add</verb> <noun>FMSAdminAccountAssociation</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account your AWS organization or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member account. The account that you associate with AWS Firewall Manager is called the AWS Firewall Manager administrator account. </para> </description> <syntax> <syntaxItem> <name>Add-FMSAdminAccountAssociation</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>AdminAccount</name> <description> <para>The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html">Managing the AWS Accounts in Your Organization</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 AdminAccount 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>AdminAccount</name> <description> <para>The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html">Managing the AWS Accounts in Your Organization</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>PassThru</name> <description> <para>Returns the value passed to the AdminAccount 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 AdminAccount parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.FMS.Model.AssociateAdminAccountResponse) can be referenced from properties attached to the cmdlet entry in the $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-FMSAdminAccountAssociation.html&tocid=Add-FMSAdminAccountAssociation</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-FMSAdminAccount</name> <description> <para>Calls the Firewall Management Service GetAdminAccount API operation.</para> </description> <verb>Get</verb> <noun>FMSAdminAccount</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator. </para> </description> <syntax> <syntaxItem> <name>Get-FMSAdminAccount</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.FMS.Model.GetAdminAccountResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.FMS.Model.GetAdminAccountResponse 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-FMSAdminAccount.html&tocid=Get-FMSAdminAccount</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-FMSComplianceDetail</name> <description> <para>Calls the Firewall Management Service GetComplianceDetail API operation.</para> </description> <verb>Get</verb> <noun>FMSComplianceDetail</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered non-compliant if the specified policy has not been applied to them. </para> </description> <syntax> <syntaxItem> <name>Get-FMSComplianceDetail</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The ID of the policy that you want to get the details for. <code>PolicyId</code> is returned by <code>PutPolicy</code> and by <code>ListPolicies</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MemberAccount</name> <description> <para>The AWS account that owns the resources that you want to get the details for. </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>MemberAccount</name> <description> <para>The AWS account that owns the resources that you want to get the 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="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The ID of the policy that you want to get the details for. <code>PolicyId</code> is returned by <code>PutPolicy</code> and by <code>ListPolicies</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.FMS.Model.PolicyComplianceDetail</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.FMS.Model.PolicyComplianceDetail object. The service call response (type Amazon.FMS.Model.GetComplianceDetailResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-FMSComplianceDetail.html&tocid=Get-FMSComplianceDetail</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-FMSComplianceStatusList</name> <description> <para>Calls the Firewall Management Service ListComplianceStatus API operation.</para> </description> <verb>Get</verb> <noun>FMSComplianceStatusList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <code>PolicyComplianceStatus</code> objects in the response. Use <code>PolicyComplianceStatus</code> to get a summary of which member accounts are protected by the specified policy.<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-FMSComplianceStatusList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The ID of the AWS Firewall Manager policy that you want the 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>MaxResult</name> <description> <para>Specifies the number of <code>PolicyComplianceStatus</code> objects that you want AWS Firewall Manager to return for this request. If you have more <code>PolicyComplianceStatus</code> objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of <code>PolicyComplianceStatus</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>NextToken</name> <description> <para>If you specify a value for <code>MaxResults</code> and you have more <code>PolicyComplianceStatus</code> objects than the number that you specify for <code>MaxResults</code>, AWS Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of <code>PolicyComplianceStatus</code> objects. For the second and subsequent <code>ListComplianceStatus</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of <code>PolicyComplianceStatus</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </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>Specifies the number of <code>PolicyComplianceStatus</code> objects that you want AWS Firewall Manager to return for this request. If you have more <code>PolicyComplianceStatus</code> objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of <code>PolicyComplianceStatus</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>NextToken</name> <description> <para>If you specify a value for <code>MaxResults</code> and you have more <code>PolicyComplianceStatus</code> objects than the number that you specify for <code>MaxResults</code>, AWS Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of <code>PolicyComplianceStatus</code> objects. For the second and subsequent <code>ListComplianceStatus</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of <code>PolicyComplianceStatus</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to 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="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The ID of the AWS Firewall Manager policy that you want the details 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.FMS.Model.PolicyComplianceStatus</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Amazon.FMS.Model.PolicyComplianceStatus objects. The service call response (type Amazon.FMS.Model.ListComplianceStatusResponse) 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-FMSComplianceStatusList.html&tocid=Get-FMSComplianceStatusList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-FMSMemberAccountList</name> <description> <para>Calls the Firewall Management Service ListMemberAccounts API operation.</para> </description> <verb>Get</verb> <noun>FMSMemberAccountList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a <code>MemberAccounts</code> object that lists the member accounts in the administrator's AWS organization. The <code>ListMemberAccounts</code> must be submitted by the account that is set as the AWS Firewall Manager administrator. <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-FMSMemberAccountList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Specifies the number of member account IDs that you want AWS Firewall Manager to return for this request. If you have more IDs than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of member account IDs. </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 you specify a value for <code>MaxResults</code> and you have more account IDs than the number that you specify for <code>MaxResults</code>, AWS Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of IDs. For the second and subsequent <code>ListMemberAccountsRequest</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of member account IDs. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </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>Specifies the number of member account IDs that you want AWS Firewall Manager to return for this request. If you have more IDs than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of member account IDs. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</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 you specify a value for <code>MaxResults</code> and you have more account IDs than the number that you specify for <code>MaxResults</code>, AWS Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of IDs. For the second and subsequent <code>ListMemberAccountsRequest</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of member account IDs. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </description> <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 System.String objects. The service call response (type Amazon.FMS.Model.ListMemberAccountsResponse) 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-FMSMemberAccountList.html&tocid=Get-FMSMemberAccountList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-FMSNotificationChannel</name> <description> <para>Calls the Firewall Management Service GetNotificationChannel API operation.</para> </description> <verb>Get</verb> <noun>FMSNotificationChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs. </para> </description> <syntax> <syntaxItem> <name>Get-FMSNotificationChannel</name> </syntaxItem> </syntax> <parameters /> <returnValues> <returnValue> <type> <name>Amazon.FMS.Model.GetNotificationChannelResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.FMS.Model.GetNotificationChannelResponse 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-FMSNotificationChannel.html&tocid=Get-FMSNotificationChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-FMSPolicy</name> <description> <para>Calls the Firewall Management Service GetPolicy API operation.</para> </description> <verb>Get</verb> <noun>FMSPolicy</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns information about the specified AWS Firewall Manager policy. </para> </description> <syntax> <syntaxItem> <name>Get-FMSPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The ID of the AWS Firewall Manager policy that you want the details 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>PolicyId</name> <description> <para>The ID of the AWS Firewall Manager policy that you want the details 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.FMS.Model.GetPolicyResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.FMS.Model.GetPolicyResponse 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-FMSPolicy.html&tocid=Get-FMSPolicy</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-FMSPolicyList</name> <description> <para>Calls the Firewall Management Service ListPolicies API operation.</para> </description> <verb>Get</verb> <noun>FMSPolicyList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns an array of <code>PolicySummary</code> 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-FMSPolicyList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MaxResult</name> <description> <para>Specifies the number of <code>PolicySummary</code> objects that you want AWS Firewall Manager to return for this request. If you have more <code>PolicySummary</code> objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of <code>PolicySummary</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>NextToken</name> <description> <para>If you specify a value for <code>MaxResults</code> and you have more <code>PolicySummary</code> objects than the number that you specify for <code>MaxResults</code>, AWS Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of <code>PolicySummary</code> objects. For the second and subsequent <code>ListPolicies</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of <code>PolicySummary</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </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>Specifies the number of <code>PolicySummary</code> objects that you want AWS Firewall Manager to return for this request. If you have more <code>PolicySummary</code> objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of <code>PolicySummary</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>NextToken</name> <description> <para>If you specify a value for <code>MaxResults</code> and you have more <code>PolicySummary</code> objects than the number that you specify for <code>MaxResults</code>, AWS Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of <code>PolicySummary</code> objects. For the second and subsequent <code>ListPolicies</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of <code>PolicySummary</code> objects. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.FMS.Model.PolicySummary</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Amazon.FMS.Model.PolicySummary objects. The service call response (type Amazon.FMS.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-FMSPolicyList.html&tocid=Get-FMSPolicyList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-FMSProtectionStatus</name> <description> <para>Calls the Firewall Management Service GetProtectionStatus API operation.</para> </description> <verb>Get</verb> <noun>FMSProtectionStatus</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. </para> </description> <syntax> <syntaxItem> <name>Get-FMSProtectionStatus</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The ID of the policy for which you want to get the attack information. </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 end of the time period to query for the attacks. This is a <code>timestamp</code> type. The sample request above indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid <code>timestamp</code> format is allowed. </para> </description> <parameterValue required="true" variableLength="false">System.DateTime</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>MemberAccountId</name> <description> <para>The AWS account that is in scope of the policy that you want to get the 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>StartTime</name> <description> <para>The start of the time period to query for the attacks. This is a <code>timestamp</code> type. The sample request above indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid <code>timestamp</code> format is allowed. </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>Specifies the number of objects that you want AWS Firewall Manager to return for this request. If you have more objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of objects. </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 you specify a value for <code>MaxResults</code> and you have more objects than the number that you specify for <code>MaxResults</code>, AWS Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of objects. For the second and subsequent <code>GetProtectionStatus</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of objects. </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 period to query for the attacks. This is a <code>timestamp</code> type. The sample request above indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid <code>timestamp</code> format is allowed. </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>Specifies the number of objects that you want AWS Firewall Manager to return for this request. If you have more objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of 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>MemberAccountId</name> <description> <para>The AWS account that is in scope of the policy that you want to get the 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>NextToken</name> <description> <para>If you specify a value for <code>MaxResults</code> and you have more objects than the number that you specify for <code>MaxResults</code>, AWS Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of objects. For the second and subsequent <code>GetProtectionStatus</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of 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="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The ID of the policy for which you want to get the attack 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>StartTime</name> <description> <para>The start of the time period to query for the attacks. This is a <code>timestamp</code> type. The sample request above indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid <code>timestamp</code> format is allowed. </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.FMS.Model.GetProtectionStatusResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.FMS.Model.GetProtectionStatusResponse 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-FMSProtectionStatus.html&tocid=Get-FMSProtectionStatus</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/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-FMSAdminAccountAssociation</name> <description> <para>Calls the Firewall Management Service DisassociateAdminAccount API operation.</para> </description> <verb>Remove</verb> <noun>FMSAdminAccountAssociation</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Disassociates the account that has been set as the AWS Firewall Manager administrator account. To set a different account as the administrator account, you must submit an <code>AssociateAdminAccount</code> request . </para> </description> <syntax> <syntaxItem> <name>Remove-FMSAdminAccountAssociation</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.FMS.Model.DisassociateAdminAccountResponse) can be referenced from properties attached to the cmdlet entry in the $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-FMSAdminAccountAssociation.html&tocid=Remove-FMSAdminAccountAssociation</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/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-FMSNotificationChannel</name> <description> <para>Calls the Firewall Management Service DeleteNotificationChannel API operation.</para> </description> <verb>Remove</verb> <noun>FMSNotificationChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs. </para> </description> <syntax> <syntaxItem> <name>Remove-FMSNotificationChannel</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.FMS.Model.DeleteNotificationChannelResponse) can be referenced from properties attached to the cmdlet entry in the $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-FMSNotificationChannel.html&tocid=Remove-FMSNotificationChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/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-FMSPolicy</name> <description> <para>Calls the Firewall Management Service DeletePolicy API operation.</para> </description> <verb>Remove</verb> <noun>FMSPolicy</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Permanently deletes an AWS Firewall Manager policy. </para> </description> <syntax> <syntaxItem> <name>Remove-FMSPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>PolicyId</name> <description> <para>The ID of the policy that you want to delete. <code>PolicyId</code> is returned by <code>PutPolicy</code> and by <code>ListPolicies</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>DeleteAllPolicyResource</name> <description> <para>If <code>True</code>, the request will also perform a clean-up process that will: - Delete rule groups created by AWS Firewall Manager - Remove web ACLs from in-scope resources - Delete web ACLs that contain no rules or rule groups After the cleanup, in-scope resources will no longer be protected by web ACLs in this policy. Protection of out-of-scope resources will remain unchanged. Scope is determined by tags and accounts associated with the policy. When creating the policy, if you specified that only resources in specific accounts or with specific tags be protected by the policy, those resources are in-scope. All others are out of scope. If you did not specify tags or accounts, all resources are in-scope. </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 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>DeleteAllPolicyResource</name> <description> <para>If <code>True</code>, the request will also perform a clean-up process that will: - Delete rule groups created by AWS Firewall Manager - Remove web ACLs from in-scope resources - Delete web ACLs that contain no rules or rule groups After the cleanup, in-scope resources will no longer be protected by web ACLs in this policy. Protection of out-of-scope resources will remain unchanged. Scope is determined by tags and accounts associated with the policy. When creating the policy, if you specified that only resources in specific accounts or with specific tags be protected by the policy, those resources are in-scope. All others are out of scope. If you did not specify tags or accounts, all resources are in-scope. </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 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 ID of the policy that you want to delete. <code>PolicyId</code> is returned by <code>PutPolicy</code> and by <code>ListPolicies</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 PolicyId parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.FMS.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-FMSPolicy.html&tocid=Remove-FMSPolicy</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/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-FMSPolicy</name> <description> <para>Calls the Firewall Management Service PutPolicy API operation.</para> </description> <verb>Set</verb> <noun>FMSPolicy</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates an AWS Firewall Manager policy. Firewall Manager provides two types of policies: A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources, or a WAF policy, which contains a rule group and defines which resources are to be protected by that rule group. A policy is specific to either WAF or Shield Advanced. If you want to enforce both WAF rules and Shield Advanced protection across accounts, you can create multiple policies. You can create one or more policies for WAF rules, and one or more policies for Shield Advanced. You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information on subscribing to Shield Advanced, see <a href="https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html">CreateSubscription</a>. </para> </description> <syntax> <syntaxItem> <name>Set-FMSPolicy</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>Policy</name> <description> <para>The details of the AWS Firewall Manager policy to be created. </para> </description> <parameterValue required="true" variableLength="false">Amazon.FMS.Model.Policy</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="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>Policy</name> <description> <para>The details of the AWS Firewall Manager policy to be created. </para> </description> <parameterValue required="true" variableLength="false">Amazon.FMS.Model.Policy</parameterValue> <type> <name>Amazon.FMS.Model.Policy</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.FMS.Model.PutPolicyResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a Amazon.FMS.Model.PutPolicyResponse 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=Set-FMSPolicy.html&tocid=Set-FMSPolicy</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/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-FMSNotificationChannel</name> <description> <para>Calls the Firewall Management Service PutNotificationChannel API operation.</para> </description> <verb>Write</verb> <noun>FMSNotificationChannel</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs. </para> </description> <syntax> <syntaxItem> <name>Write-FMSNotificationChannel</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1"> <name>SnsTopicArn</name> <description> <para>The Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS Firewall Manager. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named"> <name>SnsRoleName</name> <description> <para>The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity. </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 SnsTopicArn 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 SnsTopicArn 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>SnsRoleName</name> <description> <para>The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity. </para> </description> <parameterValue required="true" variableLength="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>SnsTopicArn</name> <description> <para>The Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS Firewall Manager. </para> </description> <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 SnsTopicArn parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.FMS.Model.PutNotificationChannelResponse) can be referenced from properties attached to the cmdlet entry in the $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-FMSNotificationChannel.html&tocid=Write-FMSNotificationChannel</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> <navigationLink> <linkText>Developer Guide:</linkText> <uri>http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html</uri> </navigationLink> <navigationLink> <linkText>Service API Reference:</linkText> <uri>https://docs.aws.amazon.com/fms/2018-01-01/APIReference/</uri> </navigationLink> </relatedLinks> </command> </helpItems> |