AWS.Tools.ApplicationCostProfiler.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ApplicationCostProfiler</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.ACP.GetACPReportDefinitionCmdlet"> <summary> Retrieves the definition of a report already configured in AWS Application Cost Profiler. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.GetACPReportDefinitionCmdlet.ReportId"> <summary> <para> <para>ID of the report to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.GetACPReportDefinitionCmdlet.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.ApplicationCostProfiler.Model.GetReportDefinitionResponse). Specifying the name of a property of type Amazon.ApplicationCostProfiler.Model.GetReportDefinitionResponse 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.ACP.GetACPReportDefinitionListCmdlet"> <summary> Retrieves a list of all reports and their configurations for your AWS account. <para> The maximum number of reports is one. </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. This cmdlet didn't autopaginate in V4, auto-pagination support was added in V5. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.GetACPReportDefinitionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</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.ACP.GetACPReportDefinitionListCmdlet.NextToken"> <summary> <para> <para>The token value from a previous call to access the next page 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/>'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.ACP.GetACPReportDefinitionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportDefinitions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApplicationCostProfiler.Model.ListReportDefinitionsResponse). Specifying the name of a property of type Amazon.ApplicationCostProfiler.Model.ListReportDefinitionsResponse 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.ACP.GetACPReportDefinitionListCmdlet.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.ACP.ImportACPApplicationUsageCmdlet"> <summary> Ingests application usage data from Amazon Simple Storage Service (Amazon S3). <para> The data must already exist in the S3 location. As part of the action, AWS Application Cost Profiler copies the object from your S3 bucket to an S3 bucket owned by Amazon for processing asynchronously. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.ImportACPApplicationUsageCmdlet.SourceS3Location_Bucket"> <summary> <para> <para>Name of the bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.ImportACPApplicationUsageCmdlet.SourceS3Location_Key"> <summary> <para> <para>Key of the object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.ImportACPApplicationUsageCmdlet.SourceS3Location_Region"> <summary> <para> <para>Region of the bucket. Only required for Regions that are disabled by default. For more infomration about Regions that are disabled by default, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable"> Enabling a Region</a> in the <i>AWS General Reference guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.ImportACPApplicationUsageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImportId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApplicationCostProfiler.Model.ImportApplicationUsageResponse). Specifying the name of a property of type Amazon.ApplicationCostProfiler.Model.ImportApplicationUsageResponse 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.ACP.ImportACPApplicationUsageCmdlet.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.ACP.RemoveACPReportDefinitionCmdlet"> <summary> Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being generated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.RemoveACPReportDefinitionCmdlet.ReportId"> <summary> <para> <para>Required. ID of the report to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.RemoveACPReportDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApplicationCostProfiler.Model.DeleteReportDefinitionResponse). Specifying the name of a property of type Amazon.ApplicationCostProfiler.Model.DeleteReportDefinitionResponse 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.ACP.RemoveACPReportDefinitionCmdlet.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.ACP.UpdateACPReportDefinitionCmdlet"> <summary> Updates existing report in AWS Application Cost Profiler. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.UpdateACPReportDefinitionCmdlet.DestinationS3Location_Bucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.UpdateACPReportDefinitionCmdlet.Format"> <summary> <para> <para>Required. The format to use for the generated report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.UpdateACPReportDefinitionCmdlet.DestinationS3Location_Prefix"> <summary> <para> <para>Prefix for the location to write to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.UpdateACPReportDefinitionCmdlet.ReportDescription"> <summary> <para> <para>Required. Description of the report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.UpdateACPReportDefinitionCmdlet.ReportFrequency"> <summary> <para> <para>Required. The cadence to generate the report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.UpdateACPReportDefinitionCmdlet.ReportId"> <summary> <para> <para>Required. ID of the report to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.UpdateACPReportDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApplicationCostProfiler.Model.UpdateReportDefinitionResponse). Specifying the name of a property of type Amazon.ApplicationCostProfiler.Model.UpdateReportDefinitionResponse 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.ACP.UpdateACPReportDefinitionCmdlet.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.ACP.WriteACPReportDefinitionCmdlet"> <summary> Creates the report definition for a report in Application Cost Profiler. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.WriteACPReportDefinitionCmdlet.DestinationS3Location_Bucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.WriteACPReportDefinitionCmdlet.Format"> <summary> <para> <para>Required. The format to use for the generated report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.WriteACPReportDefinitionCmdlet.DestinationS3Location_Prefix"> <summary> <para> <para>Prefix for the location to write to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.WriteACPReportDefinitionCmdlet.ReportDescription"> <summary> <para> <para>Required. Description of the report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.WriteACPReportDefinitionCmdlet.ReportFrequency"> <summary> <para> <para>Required. The cadence to generate the report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.WriteACPReportDefinitionCmdlet.ReportId"> <summary> <para> <para>Required. ID of the report. You can choose any valid string matching the pattern for the ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.ACP.WriteACPReportDefinitionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ApplicationCostProfiler.Model.PutReportDefinitionResponse). Specifying the name of a property of type Amazon.ApplicationCostProfiler.Model.PutReportDefinitionResponse 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.ACP.WriteACPReportDefinitionCmdlet.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> |