AWS.Tools.CostAndUsageReport

3.3.563.1

AWS.Tools.CostAndUsageReport.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>Get-CURReportDefinition</name>
      <description>
        <para>Calls the AWS Cost and Usage Report DescribeReportDefinitions API operation.</para>
      </description>
      <verb>Get</verb>
      <noun>CURReportDefinition</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Lists the AWS Cost and Usage reports available to this account.<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-CURReportDefinition</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>MaxResult</name>
          <description>
            <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </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>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
<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>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </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>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
<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.CostAndUsageReport.Model.ReportDefinition</name>
          <uri />
          <description />
        </type>
        <description>
          <para>This cmdlet returns a collection of Amazon.CostAndUsageReport.Model.ReportDefinition objects.
The service call response (type Amazon.CostAndUsageReport.Model.DescribeReportDefinitionsResponse) 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-CURReportDefinition.html&amp;tocid=Get-CURReportDefinition</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>
    </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-CURReportDefinition</name>
      <description>
        <para>Calls the AWS Cost and Usage Report DeleteReportDefinition API operation.</para>
      </description>
      <verb>Remove</verb>
      <noun>CURReportDefinition</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Deletes the specified report. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Remove-CURReportDefinition</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByValue, )" position="1">
          <name>ReportName</name>
          <description>
            <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</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>ReportName</name>
        <description>
          <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </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 System.String object.
The service call response (type Amazon.CostAndUsageReport.Model.DeleteReportDefinitionResponse) 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=Remove-CURReportDefinition.html&amp;tocid=Remove-CURReportDefinition</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>
    </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-CURReportDefinition</name>
      <description>
        <para>Calls the AWS Cost and Usage Report PutReportDefinition API operation.</para>
      </description>
      <verb>Write</verb>
      <noun>CURReportDefinition</noun>
      <copyright>
        <para>&amp;copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para>
      </copyright>
    </details>
    <description>
      <para>Creates a new report using the description that you provide. </para>
    </description>
    <syntax>
      <syntaxItem>
        <name>Write-CURReportDefinition</name>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ReportDefinition_AdditionalArtifact</name>
          <description>
            <para>A list of manifests that you want Amazon Web Services to create for this report. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ReportDefinition_AdditionalSchemaElement</name>
          <description>
            <para>A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String[]</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ReportDefinition_Compression</name>
          <description>
            <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.CostAndUsageReport.CompressionFormat</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ReportDefinition_Format</name>
          <description>
            <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.CostAndUsageReport.ReportFormat</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ReportDefinition_RefreshClosedReport</name>
          <description>
            <para>Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.Boolean</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ReportDefinition_ReportName</name>
          <description>
            <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ReportDefinition_ReportVersioning</name>
          <description>
            <para>Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.CostAndUsageReport.ReportVersioning</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ReportDefinition_S3Bucket</name>
          <description>
            <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ReportDefinition_S3Prefix</name>
          <description>
            <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
          </description>
          <parameterValue required="true" variableLength="false">System.String</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ReportDefinition_S3Region</name>
          <description>
            <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.CostAndUsageReport.AWSRegion</parameterValue>
        </parameter>
        <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
          <name>ReportDefinition_TimeUnit</name>
          <description>
            <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
          </description>
          <parameterValue required="true" variableLength="false">Amazon.CostAndUsageReport.TimeUnit</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>ReportDefinition_AdditionalArtifact</name>
        <description>
          <para>A list of manifests that you want Amazon Web Services to create for this report. </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>ReportDefinition_AdditionalSchemaElement</name>
        <description>
          <para>A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs. </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>ReportDefinition_Compression</name>
        <description>
          <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.CostAndUsageReport.CompressionFormat</parameterValue>
        <type>
          <name>Amazon.CostAndUsageReport.CompressionFormat</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>ReportDefinition_Format</name>
        <description>
          <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.CostAndUsageReport.ReportFormat</parameterValue>
        <type>
          <name>Amazon.CostAndUsageReport.ReportFormat</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>ReportDefinition_RefreshClosedReport</name>
        <description>
          <para>Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees. </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>ReportDefinition_ReportName</name>
        <description>
          <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available 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>ReportDefinition_ReportVersioning</name>
        <description>
          <para>Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.CostAndUsageReport.ReportVersioning</parameterValue>
        <type>
          <name>Amazon.CostAndUsageReport.ReportVersioning</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>ReportDefinition_S3Bucket</name>
        <description>
          <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available 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>ReportDefinition_S3Prefix</name>
        <description>
          <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available 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>ReportDefinition_S3Region</name>
        <description>
          <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.CostAndUsageReport.AWSRegion</parameterValue>
        <type>
          <name>Amazon.CostAndUsageReport.AWSRegion</name>
          <uri />
        </type>
        <defaultValue>None</defaultValue>
      </parameter>
      <parameter required="False" variableLength="false" globbing="false" pipelineInput="False" position="Named">
        <name>ReportDefinition_TimeUnit</name>
        <description>
          <para>The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para>
        </description>
        <parameterValue required="true" variableLength="false">Amazon.CostAndUsageReport.TimeUnit</parameterValue>
        <type>
          <name>Amazon.CostAndUsageReport.TimeUnit</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.CostAndUsageReport.Model.PutReportDefinitionResponse) 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-CURReportDefinition.html&amp;tocid=Write-CURReportDefinition</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>
    </relatedLinks>
  </command>
</helpItems>