AWS.Tools.ControlCatalog.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ControlCatalog</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATCommonControlListCmdlet"> <summary> Returns a paginated list of common controls from the Amazon Web Services Control Catalog. <para> You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATCommonControlListCmdlet.CommonControlFilter_Objective"> <summary> <para> <para>The objective that's used as filter criteria.</para><para>You can use this parameter to specify one objective ARN at a time. Passing multiple ARNs in the <c>CommonControlFilter</c> isn’t currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATCommonControlListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results on a page or for an API request call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATCommonControlListCmdlet.NextToken"> <summary> <para> <para>The pagination token that's used to fetch the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATCommonControlListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CommonControls'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlCatalog.Model.ListCommonControlsResponse). Specifying the name of a property of type Amazon.ControlCatalog.Model.ListCommonControlsResponse 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.CLCAT.GetCLCATCommonControlListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATControlCmdlet"> <summary> Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the <i>ControlArn</i> parameter, in ARN form. <c>GetControl</c> accepts <i>controltower</i> or <i>controlcatalog</i> control ARNs as input. Returns a <i>controlcatalog</i> ARN format. <para> In the API response, controls that have the value <c>GLOBAL</c> in the <c>Scope</c> field do not show the <c>DeployableRegions</c> field, because it does not apply. Controls that have the value <c>REGIONAL</c> in the <c>Scope</c> field return a value for the <c>DeployableRegions</c> field, as shown in the example. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATControlCmdlet.ControlArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the control. It has one of the following formats:</para><para><i>Global format</i></para><para><c>arn:{PARTITION}:controlcatalog:::control/{CONTROL_CATALOG_OPAQUE_ID}</c></para><para><i>Or Regional format</i></para><para><c>arn:{PARTITION}:controltower:{REGION}::control/{CONTROL_TOWER_OPAQUE_ID}</c></para><para>Here is a more general pattern that covers Amazon Web Services Control Tower and Control Catalog ARNs:</para><para><c>^arn:(aws(?:[-a-z]*)?):(controlcatalog|controltower):[a-zA-Z0-9-]*::control/[0-9a-zA-Z_\\-]+$</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATControlCmdlet.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.ControlCatalog.Model.GetControlResponse). Specifying the name of a property of type Amazon.ControlCatalog.Model.GetControlResponse 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.CLCAT.GetCLCATControlCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ControlArn parameter. The -PassThru parameter is deprecated, use -Select '^ControlArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATControlListCmdlet"> <summary> Returns a paginated list of all available controls in the Amazon Web Services Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type <i>controlSummary</i>. The ARN is returned in the global <i>controlcatalog</i> format, as shown in the examples.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATControlListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results on a page or for an API request call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATControlListCmdlet.NextToken"> <summary> <para> <para>The pagination token that's used to fetch the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATControlListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Controls'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlCatalog.Model.ListControlsResponse). Specifying the name of a property of type Amazon.ControlCatalog.Model.ListControlsResponse 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.CLCAT.GetCLCATControlListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATDomainListCmdlet"> <summary> Returns a paginated list of domains from the Amazon Web Services Control Catalog.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATDomainListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results on a page or for an API request call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATDomainListCmdlet.NextToken"> <summary> <para> <para>The pagination token that's used to fetch the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATDomainListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Domains'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlCatalog.Model.ListDomainsResponse). Specifying the name of a property of type Amazon.ControlCatalog.Model.ListDomainsResponse 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.CLCAT.GetCLCATDomainListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATObjectiveListCmdlet"> <summary> Returns a paginated list of objectives from the Amazon Web Services Control Catalog. <para> You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATObjectiveListCmdlet.ObjectiveFilter_Domain"> <summary> <para> <para>The domain that's used as filter criteria.</para><para>You can use this parameter to specify one domain ARN at a time. Passing multiple ARNs in the <c>ObjectiveFilter</c> isn’t currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATObjectiveListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results on a page or for an API request call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATObjectiveListCmdlet.NextToken"> <summary> <para> <para>The pagination token that's used to fetch the next set of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CLCAT.GetCLCATObjectiveListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Objectives'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ControlCatalog.Model.ListObjectivesResponse). Specifying the name of a property of type Amazon.ControlCatalog.Model.ListObjectivesResponse 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.CLCAT.GetCLCATObjectiveListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> </members> </doc> |