AWS.Tools.Sustainability.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Sustainability</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SUST.GetSUSTEstimatedCarbonEmissionCmdlet"> <summary> Returns estimated carbon emission values based on customer grouping and filtering parameters. We recommend using pagination to ensure that the operation returns quickly and successfully.<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.SUST.GetSUSTEstimatedCarbonEmissionCmdlet.FilterBy_Dimension"> <summary> <para> <para>Filters emission values by specific dimension values.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SUST.GetSUSTEstimatedCarbonEmissionCmdlet.EmissionsType"> <summary> <para> <para>The emission types to include in the results. If absent, returns <c>TOTAL_LBM_CARBON_EMISSIONS</c> and <c>TOTAL_MBM_CARBON_EMISSIONS</c> emissions types. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SUST.GetSUSTEstimatedCarbonEmissionCmdlet.TimePeriod_End"> <summary> <para> <para>The end (exclusive) of the time period. ISO-8601 formatted timestamp, for example: <c>YYYY-MM-DDThh:mm:ss.sssZ</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SUST.GetSUSTEstimatedCarbonEmissionCmdlet.GranularityConfiguration_FiscalYearStartMonth"> <summary> <para> <para> The month (1-12) when the fiscal year begins. Used for <c>YEARLY_FISCAL</c> and <c>QUARTERLY_FISCAL</c> granularity. Defaults to 1 (January). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SUST.GetSUSTEstimatedCarbonEmissionCmdlet.Granularity"> <summary> <para> <para>The time granularity for the results. If absent, uses <c>MONTHLY</c> time granularity.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SUST.GetSUSTEstimatedCarbonEmissionCmdlet.GroupBy"> <summary> <para> <para>The dimensions available for grouping estimated carbon emissions.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SUST.GetSUSTEstimatedCarbonEmissionCmdlet.TimePeriod_Start"> <summary> <para> <para>The start (inclusive) of the time period. ISO-8601 formatted timestamp, for example: <c>YYYY-MM-DDThh:mm:ss.sssZ</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SUST.GetSUSTEstimatedCarbonEmissionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Default is 40.</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.SUST.GetSUSTEstimatedCarbonEmissionCmdlet.NextToken"> <summary> <para> <para>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. </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.SUST.GetSUSTEstimatedCarbonEmissionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Sustainability.Model.GetEstimatedCarbonEmissionsResponse). Specifying the name of a property of type Amazon.Sustainability.Model.GetEstimatedCarbonEmissionsResponse 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.SUST.GetSUSTEstimatedCarbonEmissionCmdlet.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.SUST.GetSUSTEstimatedCarbonEmissionsDimensionValueCmdlet"> <summary> Returns the possible dimension values available for a customer's account. We recommend using pagination to ensure that the operation returns quickly and successfully.<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.SUST.GetSUSTEstimatedCarbonEmissionsDimensionValueCmdlet.Dimension"> <summary> <para> <para>The dimensions available for grouping estimated carbon emissions.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SUST.GetSUSTEstimatedCarbonEmissionsDimensionValueCmdlet.TimePeriod_End"> <summary> <para> <para>The end (exclusive) of the time period. ISO-8601 formatted timestamp, for example: <c>YYYY-MM-DDThh:mm:ss.sssZ</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SUST.GetSUSTEstimatedCarbonEmissionsDimensionValueCmdlet.TimePeriod_Start"> <summary> <para> <para>The start (inclusive) of the time period. ISO-8601 formatted timestamp, for example: <c>YYYY-MM-DDThh:mm:ss.sssZ</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SUST.GetSUSTEstimatedCarbonEmissionsDimensionValueCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Default is 40.</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.SUST.GetSUSTEstimatedCarbonEmissionsDimensionValueCmdlet.NextToken"> <summary> <para> <para>The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page. </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.SUST.GetSUSTEstimatedCarbonEmissionsDimensionValueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Sustainability.Model.GetEstimatedCarbonEmissionsDimensionValuesResponse). Specifying the name of a property of type Amazon.Sustainability.Model.GetEstimatedCarbonEmissionsDimensionValuesResponse 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.SUST.GetSUSTEstimatedCarbonEmissionsDimensionValueCmdlet.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> |