AWS.Tools.FreeTier

5.0.9

AWS.Tools.FreeTier.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.FreeTier</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.FT.GetFTAccountActivityCmdlet">
            <summary>
            Returns a specific activity record that is available to the customer.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FT.GetFTAccountActivityCmdlet.ActivityId">
            <summary>
            <para>
            <para> A unique identifier that identifies the activity. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FT.GetFTAccountActivityCmdlet.LanguageCode">
            <summary>
            <para>
            <para> The language code used to return translated title and description fields. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FT.GetFTAccountActivityCmdlet.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.FreeTier.Model.GetAccountActivityResponse).
            Specifying the name of a property of type Amazon.FreeTier.Model.GetAccountActivityResponse 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.FT.GetFTAccountActivityListCmdlet">
            <summary>
            Returns a list of activities that are available. This operation supports pagination
            and filtering by status.<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.FT.GetFTAccountActivityListCmdlet.FilterActivityStatus">
            <summary>
            <para>
            <para> The activity status filter. This field can be used to filter the response by activities
            status. </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.FT.GetFTAccountActivityListCmdlet.LanguageCode">
            <summary>
            <para>
            <para> The language code used to return translated titles. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FT.GetFTAccountActivityListCmdlet.MaxResult">
            <summary>
            <para>
            <para> The maximum number of items to return for this request. To get the next page of items,
            make another request with the token returned in the output. </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.FT.GetFTAccountActivityListCmdlet.NextToken">
            <summary>
            <para>
            <para> A token from a previous paginated response. If this is specified, the response includes
            records beginning from this token (inclusive), up to the number specified by <c>maxResults</c>.
            </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.FT.GetFTAccountActivityListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'Activities'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FreeTier.Model.ListAccountActivitiesResponse).
            Specifying the name of a property of type Amazon.FreeTier.Model.ListAccountActivitiesResponse 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.FT.GetFTAccountActivityListCmdlet.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.FT.GetFTAccountPlanStateCmdlet">
            <summary>
            This returns all of the information related to the state of the account plan related
            to Free Tier.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FT.GetFTAccountPlanStateCmdlet.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.FreeTier.Model.GetAccountPlanStateResponse).
            Specifying the name of a property of type Amazon.FreeTier.Model.GetAccountPlanStateResponse 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.FT.GetFTFreeTierUsageCmdlet">
            <summary>
            Returns a list of all Free Tier usage objects that match your filters.<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.FT.GetFTFreeTierUsageCmdlet.Filter">
            <summary>
            <para>
            <para>An expression that specifies the conditions that you want each <c>FreeTierUsage</c>
            object to meet.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FT.GetFTFreeTierUsageCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximum number of results to return in the response. <c>MaxResults</c> means that
            there can be up to the specified number of values, but there might be fewer results
            based on your filters.</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.FT.GetFTFreeTierUsageCmdlet.NextToken">
            <summary>
            <para>
            <para>The pagination token that indicates the next set of results to retrieve.</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.FT.GetFTFreeTierUsageCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'FreeTierUsages'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FreeTier.Model.GetFreeTierUsageResponse).
            Specifying the name of a property of type Amazon.FreeTier.Model.GetFreeTierUsageResponse 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.FT.GetFTFreeTierUsageCmdlet.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.FT.SetFTAccountPlanCmdlet">
            <summary>
            The account plan type for the Amazon Web Services account.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FT.SetFTAccountPlanCmdlet.AccountPlanType">
            <summary>
            <para>
            <para> The target account plan type. This makes it explicit about the change and latest
            value of the <c>accountPlanType</c>. </para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.FT.SetFTAccountPlanCmdlet.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.FreeTier.Model.UpgradeAccountPlanResponse).
            Specifying the name of a property of type Amazon.FreeTier.Model.UpgradeAccountPlanResponse 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.FT.SetFTAccountPlanCmdlet.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>