Module Smaws_Client_FreeTier.Types

type nonrec value = string
type nonrec values = value list
type nonrec generic_string = string
type nonrec validation_exception = {
  1. message : generic_string;
}

The input fails to satisfy the constraints specified by an Amazon Web Services service.

type nonrec account_id = string
type nonrec account_plan_type =
  1. | PAID
  2. | FREE
type nonrec account_plan_status =
  1. | EXPIRED
  2. | ACTIVE
  3. | NOT_STARTED
type nonrec upgrade_account_plan_response = {
  1. account_plan_status : account_plan_status;
    (*

    This indicates the latest state of the account plan within its lifecycle.

    *)
  2. account_plan_type : account_plan_type;
    (*

    The type of plan for the account.

    *)
  3. account_id : account_id;
    (*

    A unique identifier that identifies the account.

    *)
}
type nonrec upgrade_account_plan_request = {
  1. account_plan_type : account_plan_type;
    (*

    The target account plan type. This makes it explicit about the change and latest value of the accountPlanType.

    *)
}
type nonrec throttling_exception = {
  1. message : generic_string;
}

The request was denied due to request throttling.

type nonrec resource_not_found_exception = {
  1. message : generic_string;
}

This exception is thrown when the requested resource cannot be found.

type nonrec internal_server_exception = {
  1. message : generic_string;
}

An unexpected error occurred during the processing of your request.

type nonrec access_denied_exception = {
  1. message : generic_string;
}

You don't have sufficient access to perform this action.

type nonrec next_page_token = string
type nonrec generic_double = float
type nonrec currency_code =
  1. | USD
type nonrec monetary_amount = {
  1. unit_ : currency_code;
    (*

    The unit that the monetary amount is given in.

    *)
  2. amount : generic_double;
    (*

    The aggregated monetary amount of credits earned.

    *)
}

The monetary amount of the credit.

type nonrec max_results = int
type nonrec match_option =
  1. | GREATER_THAN_OR_EQUAL
  2. | CONTAINS
  3. | ENDS_WITH
  4. | STARTS_WITH
  5. | EQUALS
type nonrec match_options = match_option list
type nonrec activity_id = string
type nonrec activity_reward =
  1. | Credit of monetary_amount
    (*

    The credits gained by activity rewards.

    *)

The summary of the rewards granted as a result of activities completed.

type nonrec activity_status =
  1. | EXPIRING
  2. | COMPLETED
  3. | IN_PROGRESS
  4. | NOT_STARTED
type nonrec activity_summary = {
  1. status : activity_status;
    (*

    The current status of the activity.

    *)
  2. reward : activity_reward;
    (*

    The reward for the activity.

    *)
  3. title : generic_string;
    (*

    The title of the activity.

    *)
  4. activity_id : activity_id;
    (*

    A unique identifier that identifies the activity.

    *)
}

The summary of activities.

type nonrec activities = activity_summary list
type nonrec list_account_activities_response = {
  1. next_token : next_page_token option;
    (*

    The token to include in another request to get the next page of items. This value is null when there are no more items to return.

    *)
  2. activities : activities;
    (*

    A brief information about the activities.

    *)
}
type nonrec filter_activity_statuses = activity_status list
type nonrec language_code =
  1. | TR_TR
  2. | ZH_TW
  3. | ZH_CN
  4. | KO_KR
  5. | PT_PT
  6. | IT_IT
  7. | JA_JP
  8. | FR_FR
  9. | ES_ES
  10. | DE_DE
  11. | ID_ID
  12. | EN_GB
  13. | EN_US
type nonrec list_account_activities_request = {
  1. language_code : language_code option;
    (*

    The language code used to return translated titles.

    *)
  2. max_results : max_results option;
    (*

    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.

    *)
  3. next_token : next_page_token option;
    (*

    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 maxResults.

    *)
  4. filter_activity_statuses : filter_activity_statuses option;
    (*

    The activity status filter. This field can be used to filter the response by activities status.

    *)
}
type nonrec free_tier_usage = {
  1. free_tier_type : generic_string option;
    (*

    Describes the type of the Free Tier offer. For example, the offer can be "12 Months Free", "Always Free", and "Free Trial".

    *)
  2. description : generic_string option;
    (*

    The description of the Free Tier offer.

    *)
  3. unit_ : generic_string option;
    (*

    Describes the unit of the usageType, such as Hrs.

    *)
  4. limit : generic_double option;
    (*

    Describes the maximum usage allowed in Free Tier.

    *)
  5. forecasted_usage_amount : generic_double option;
    (*

    Describes the forecasted usage by the month that you're expected to use.

    *)
  6. actual_usage_amount : generic_double option;
    (*

    Describes the actual usage accrued month-to-day (MTD) that you've used so far.

    *)
  7. region : generic_string option;
    (*

    Describes the Amazon Web Services Region for which this offer is applicable

    *)
  8. usage_type : generic_string option;
    (*

    Describes the usage details of the offer. For example, this might be Global-BoxUsage:freetrial.

    *)
  9. operation : generic_string option;
    (*

    Describes usageType more granularly with the specific Amazon Web Services service API operation. For example, this can be the RunInstances API operation for Amazon Elastic Compute Cloud.

    *)
  10. service : generic_string option;
    (*

    The name of the Amazon Web Services service providing the Free Tier offer. For example, this can be Amazon Elastic Compute Cloud.

    *)
}

Consists of a Amazon Web Services Free Tier offer’s metadata and your data usage for the offer.

type nonrec free_tier_usages = free_tier_usage list
type nonrec get_free_tier_usage_response = {
  1. next_token : next_page_token option;
    (*

    The pagination token that indicates the next set of results to retrieve.

    *)
  2. free_tier_usages : free_tier_usages;
    (*

    The list of Free Tier usage objects that meet your filter expression.

    *)
}
type nonrec dimension =
  1. | USAGE_PERCENTAGE
  2. | DESCRIPTION
  3. | FREE_TIER_TYPE
  4. | REGION
  5. | USAGE_TYPE
  6. | OPERATION
  7. | SERVICE
type nonrec dimension_values = {
  1. match_options : match_options;
    (*

    The match options that you can use to filter your results. You can specify only one of these values in the array.

    *)
  2. values : values;
    (*

    The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.

    *)
  3. key : dimension;
    (*

    The name of the dimension that you want to filter on.

    *)
}

Contains the specifications for the filters to use for your request.

type expression = {
  1. dimensions : dimension_values option;
    (*

    The specific dimension, values, and match type to filter objects with.

    *)
  2. not : expression option;
    (*

    Return results that don’t match the Expression that you specified.

    *)
  3. and_ : expressions option;
    (*

    Return results that match all Expressions that you specified in the array.

    *)
  4. or : expressions option;
    (*

    Return results that match any of the Expressions that you specified. in the array.

    *)
}

Use Expression to filter in the GetFreeTierUsage API operation.

You can use the following patterns:

  • Simple dimension values (Dimensions root operator)
  • Complex expressions with logical operators (AND, NOT, and OR root operators).

For simple dimension values, you can set the dimension name, values, and match type for the filters that you plan to use.

Example for simple dimension values

You can filter to match exactly for REGION==us-east-1 OR REGION==us-west-1.

The corresponding Expression appears like the following: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] } }

As shown in the previous example, lists of dimension values are combined with OR when you apply the filter.

For complex expressions with logical operators, you can have nested expressions to use the logical operators and specify advanced filtering.

Example for complex expressions with logical operators

You can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (SERVICE CONTAINS AWSLambda)) AND (USAGE_TYPE !CONTAINS DataTransfer).

The corresponding Expression appears like the following: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] }}, {"Dimensions": { "Key": "SERVICE", "Values": ["AWSLambda"], "MatchOptions": ["CONTAINS"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"], "MatchOptions": ["CONTAINS"] }}} ] }

In the following Contents, you must specify exactly one of the following root operators.

and expressions = expression list
type nonrec get_free_tier_usage_request = {
  1. next_token : next_page_token option;
    (*

    The pagination token that indicates the next set of results to retrieve.

    *)
  2. max_results : max_results option;
    (*

    The maximum number of results to return in the response. MaxResults means that there can be up to the specified number of values, but there might be fewer results based on your filters.

    *)
  3. filter : expression option;
    (*

    An expression that specifies the conditions that you want each FreeTierUsage object to meet.

    *)
}
type nonrec get_account_plan_state_response = {
  1. account_plan_expiration_date : Smaws_Lib.Smithy_api.Types.timestamp option;
    (*

    The timestamp for when the current account plan expires.

    *)
  2. account_plan_remaining_credits : monetary_amount option;
    (*

    The amount of credits remaining for the account.

    *)
  3. account_plan_status : account_plan_status;
    (*

    The current status for the account plan.

    *)
  4. account_plan_type : account_plan_type;
    (*

    The plan type for the account.

    *)
  5. account_id : account_id;
    (*

    A unique identifier that identifies the account.

    *)
}
type nonrec get_account_plan_state_request = unit
type nonrec get_account_activity_response = {
  1. completed_at : Smaws_Lib.Smithy_api.Types.timestamp option;
    (*

    The timestamp when the activity is completed. This field appears only for activities in the COMPLETED state.

    *)
  2. started_at : Smaws_Lib.Smithy_api.Types.timestamp option;
    (*

    The timestamp when the activity started. This field appears only for activities in the IN_PROGRESS or COMPLETED states.

    *)
  3. expires_at : Smaws_Lib.Smithy_api.Types.timestamp option;
    (*

    The time by which the activity must be completed to receive a reward.

    *)
  4. estimated_time_to_complete_in_minutes : Smaws_Lib.Smithy_api.Types.integer option;
    (*

    The estimated time to complete the activity. This is the duration in minutes.

    *)
  5. reward : activity_reward;
    (*

    A reward granted upon activity completion.

    *)
  6. instructions_url : generic_string;
    (*

    The URL resource that provides guidance on activity requirements and completion.

    *)
  7. status : activity_status;
    (*

    The current activity status.

    *)
  8. description : generic_string;
    (*

    Provides detailed information about the activity and its expected outcomes.

    *)
  9. title : generic_string;
    (*

    A short activity title.

    *)
  10. activity_id : activity_id;
    (*

    A unique identifier that identifies the activity.

    *)
}
type nonrec get_account_activity_request = {
  1. language_code : language_code option;
    (*

    The language code used to return translated title and description fields.

    *)
  2. activity_id : activity_id;
    (*

    A unique identifier that identifies the activity.

    *)
}