AWS.Tools.Artifact.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Artifact</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.ART.GetARTAccountSettingCmdlet"> <summary> Get the account settings for Artifact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTAccountSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccountSettings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Artifact.Model.GetAccountSettingsResponse). Specifying the name of a property of type Amazon.Artifact.Model.GetAccountSettingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ART.GetARTCustomerAgreementListCmdlet"> <summary> List active customer-agreements applicable to calling identity.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTCustomerAgreementListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of resources to return in the paginated response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTCustomerAgreementListCmdlet.NextToken"> <summary> <para> <para>Pagination token to request the next page of resources.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTCustomerAgreementListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CustomerAgreements'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Artifact.Model.ListCustomerAgreementsResponse). Specifying the name of a property of type Amazon.Artifact.Model.ListCustomerAgreementsResponse 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.ART.GetARTCustomerAgreementListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ART.GetARTReportCmdlet"> <summary> Get the content for a single report. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTReportCmdlet.ReportId"> <summary> <para> <para>Unique resource ID for the report resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTReportCmdlet.ReportVersion"> <summary> <para> <para>Version for the report resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTReportCmdlet.TermToken"> <summary> <para> <para>Unique download token provided by GetTermForReport API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTReportCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DocumentPresignedUrl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Artifact.Model.GetReportResponse). Specifying the name of a property of type Amazon.Artifact.Model.GetReportResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ART.GetARTReportListCmdlet"> <summary> List available reports.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTReportListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of resources to return in the paginated response.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTReportListCmdlet.NextToken"> <summary> <para> <para>Pagination token to request the next page of resources.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTReportListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Reports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Artifact.Model.ListReportsResponse). Specifying the name of a property of type Amazon.Artifact.Model.ListReportsResponse 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.ART.GetARTReportListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. This cmdlet didn't autopaginate in V4. To preserve the V4 autopagination behavior for all cmdlets, run Set-AWSAutoIterationMode -IterationMode v4. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ART.GetARTReportMetadataCmdlet"> <summary> Get the metadata for a single report. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTReportMetadataCmdlet.ReportId"> <summary> <para> <para>Unique resource ID for the report resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTReportMetadataCmdlet.ReportVersion"> <summary> <para> <para>Version for the report resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTReportMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportDetails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Artifact.Model.GetReportMetadataResponse). Specifying the name of a property of type Amazon.Artifact.Model.GetReportMetadataResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ART.GetARTTermForReportCmdlet"> <summary> Get the Term content associated with a single report. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTTermForReportCmdlet.ReportId"> <summary> <para> <para>Unique resource ID for the report resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTTermForReportCmdlet.ReportVersion"> <summary> <para> <para>Version for the report resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.GetARTTermForReportCmdlet.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.Artifact.Model.GetTermForReportResponse). Specifying the name of a property of type Amazon.Artifact.Model.GetTermForReportResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.ART.WriteARTAccountSettingCmdlet"> <summary> Put the account settings for Artifact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.WriteARTAccountSettingCmdlet.NotificationSubscriptionStatus"> <summary> <para> <para>Desired notification subscription status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ART.WriteARTAccountSettingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AccountSettings'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Artifact.Model.PutAccountSettingsResponse). Specifying the name of a property of type Amazon.Artifact.Model.PutAccountSettingsResponse 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.ART.WriteARTAccountSettingCmdlet.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> |