<?php
// This file was auto-generated from sdk-root/src/data/freetier/2023-09-07/docs-2.json
return [ 'version' => '2.0', 'service' => '<p>You can use the Amazon Web Services Free Tier API to query programmatically your Free Tier usage data.</p> <p>Free Tier tracks your monthly usage data for all free tier offers that are associated with your Amazon Web Services account. You can use the Free Tier API to filter and show only the data that you want.</p> <p>Service endpoint</p> <p>The Free Tier API provides the following endpoint:</p> <ul/> <p>For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-free-tier.html">Using the Amazon Web Services Free Tier</a> in the <i>Billing User Guide</i>.</p>', 'operations' => [ 'GetAccountActivity' => '<p> Returns a specific activity record that is available to the customer. </p>', 'GetAccountPlanState' => '<p> This returns all of the information related to the state of the account plan related to Free Tier. </p>', 'GetFreeTierUsage' => '<p>Returns a list of all Free Tier usage objects that match your filters.</p>', 'ListAccountActivities' => '<p> Returns a list of activities that are available. This operation supports pagination and filtering by status. </p>', 'UpgradeAccountPlan' => '<p> The account plan type for the Amazon Web Services account. </p>', ], 'shapes' => [ 'AccessDeniedException' => [ 'base' => '<p> You don\'t have sufficient access to perform this action. </p>', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'GetAccountPlanStateResponse$accountId' => '<p> A unique identifier that identifies the account. </p>', 'UpgradeAccountPlanResponse$accountId' => '<p> A unique identifier that identifies the account. </p>', ], ], 'AccountPlanStatus' => [ 'base' => NULL, 'refs' => [ 'GetAccountPlanStateResponse$accountPlanStatus' => '<p> The current status for the account plan. </p>', 'UpgradeAccountPlanResponse$accountPlanStatus' => '<p> This indicates the latest state of the account plan within its lifecycle. </p>', ], ], 'AccountPlanType' => [ 'base' => NULL, 'refs' => [ 'GetAccountPlanStateResponse$accountPlanType' => '<p> The plan type for the account. </p>', 'UpgradeAccountPlanRequest$accountPlanType' => '<p> The target account plan type. This makes it explicit about the change and latest value of the <code>accountPlanType</code>. </p>', 'UpgradeAccountPlanResponse$accountPlanType' => '<p> The type of plan for the account. </p>', ], ], 'Activities' => [ 'base' => NULL, 'refs' => [ 'ListAccountActivitiesResponse$activities' => '<p> A brief information about the activities. </p>', ], ], 'ActivityId' => [ 'base' => NULL, 'refs' => [ 'ActivitySummary$activityId' => '<p> A unique identifier that identifies the activity. </p>', 'GetAccountActivityRequest$activityId' => '<p> A unique identifier that identifies the activity. </p>', 'GetAccountActivityResponse$activityId' => '<p> A unique identifier that identifies the activity. </p>', ], ], 'ActivityReward' => [ 'base' => '<p> The summary of the rewards granted as a result of activities completed. </p>', 'refs' => [ 'ActivitySummary$reward' => '<p> The reward for the activity. </p>', 'GetAccountActivityResponse$reward' => '<p> A reward granted upon activity completion. </p>', ], ], 'ActivityStatus' => [ 'base' => NULL, 'refs' => [ 'ActivitySummary$status' => '<p> The current status of the activity. </p>', 'FilterActivityStatuses$member' => NULL, 'GetAccountActivityResponse$status' => '<p> The current activity status. </p>', ], ], 'ActivitySummary' => [ 'base' => '<p> The summary of activities. </p>', 'refs' => [ 'Activities$member' => NULL, ], ], 'CurrencyCode' => [ 'base' => NULL, 'refs' => [ 'MonetaryAmount$unit' => '<p> The unit that the monetary amount is given in. </p>', ], ], 'Dimension' => [ 'base' => NULL, 'refs' => [ 'DimensionValues$Key' => '<p>The name of the dimension that you want to filter on.</p>', ], ], 'DimensionValues' => [ 'base' => '<p>Contains the specifications for the filters to use for your request.</p>', 'refs' => [ 'Expression$Dimensions' => '<p>The specific dimension, values, and match type to filter objects with.</p>', ], ], 'Expression' => [ 'base' => '<p>Use <code>Expression</code> to filter in the <code>GetFreeTierUsage</code> API operation.</p> <p>You can use the following patterns:</p> <ul> <li> <p>Simple dimension values (<code>Dimensions</code> root operator)</p> </li> <li> <p>Complex expressions with logical operators (<code>AND</code>, <code>NOT</code>, and <code>OR</code> root operators).</p> </li> </ul> <p>For <i>simple dimension values</i>, you can set the dimension name, values, and match type for the filters that you plan to use.</p> <p> <b>Example for simple dimension values</b> </p> <p>You can filter to match exactly for <code>REGION==us-east-1 OR REGION==us-west-1</code>.</p> <p>The corresponding <code>Expression</code> appears like the following: <code>{ "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ], "MatchOptions": ["EQUALS"] } }</code> </p> <p>As shown in the previous example, lists of dimension values are combined with <code>OR</code> when you apply the filter.</p> <p>For <i>complex expressions with logical operators</i>, you can have nested expressions to use the logical operators and specify advanced filtering.</p> <p> <b>Example for complex expressions with logical operators</b> </p> <p>You can filter by <code>((REGION == us-east-1 OR REGION == us-west-1) OR (SERVICE CONTAINS AWSLambda)) AND (USAGE_TYPE !CONTAINS DataTransfer)</code>.</p> <p>The corresponding <code>Expression</code> appears like the following: <code>{ "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"] }}} ] }</code> </p> <p>In the following <b>Contents</b>, you must specify exactly one of the following root operators.</p>', 'refs' => [ 'Expression$Not' => '<p>Return results that don’t match the <code>Expression</code> that you specified.</p>', 'Expressions$member' => NULL, 'GetFreeTierUsageRequest$filter' => '<p>An expression that specifies the conditions that you want each <code>FreeTierUsage</code> object to meet.</p>', ], ], 'Expressions' => [ 'base' => NULL, 'refs' => [ 'Expression$Or' => '<p>Return results that match any of the <code>Expressions</code> that you specified. in the array.</p>', 'Expression$And' => '<p>Return results that match all <code>Expressions</code> that you specified in the array.</p>', ], ], 'FilterActivityStatuses' => [ 'base' => NULL, 'refs' => [ 'ListAccountActivitiesRequest$filterActivityStatuses' => '<p> The activity status filter. This field can be used to filter the response by activities status. </p>', ], ], 'FreeTierUsage' => [ 'base' => '<p>Consists of a Amazon Web Services Free Tier offer’s metadata and your data usage for the offer.</p>', 'refs' => [ 'FreeTierUsages$member' => NULL, ], ], 'FreeTierUsages' => [ 'base' => NULL, 'refs' => [ 'GetFreeTierUsageResponse$freeTierUsages' => '<p>The list of Free Tier usage objects that meet your filter expression.</p>', ], ], 'GenericDouble' => [ 'base' => NULL, 'refs' => [ 'FreeTierUsage$actualUsageAmount' => '<p>Describes the actual usage accrued month-to-day (MTD) that you\'ve used so far.</p>', 'FreeTierUsage$forecastedUsageAmount' => '<p>Describes the forecasted usage by the month that you\'re expected to use.</p>', 'FreeTierUsage$limit' => '<p>Describes the maximum usage allowed in Free Tier.</p>', 'MonetaryAmount$amount' => '<p> The aggregated monetary amount of credits earned. </p>', ], ], 'GenericString' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ActivitySummary$title' => '<p> The title of the activity. </p>', 'FreeTierUsage$service' => '<p>The name of the Amazon Web Services service providing the Free Tier offer. For example, this can be Amazon Elastic Compute Cloud.</p>', 'FreeTierUsage$operation' => '<p>Describes <code>usageType</code> more granularly with the specific Amazon Web Services service API operation. For example, this can be the <code>RunInstances</code> API operation for Amazon Elastic Compute Cloud.</p>', 'FreeTierUsage$usageType' => '<p>Describes the usage details of the offer. For example, this might be <code>Global-BoxUsage:freetrial</code>.</p>', 'FreeTierUsage$region' => '<p>Describes the Amazon Web Services Region for which this offer is applicable</p>', 'FreeTierUsage$unit' => '<p>Describes the unit of the <code>usageType</code>, such as <code>Hrs</code>.</p>', 'FreeTierUsage$description' => '<p>The description of the Free Tier offer.</p>', 'FreeTierUsage$freeTierType' => '<p>Describes the type of the Free Tier offer. For example, the offer can be <code>"12 Months Free"</code>, <code>"Always Free"</code>, and <code>"Free Trial"</code>.</p>', 'GetAccountActivityResponse$title' => '<p> A short activity title. </p>', 'GetAccountActivityResponse$description' => '<p> Provides detailed information about the activity and its expected outcomes. </p>', 'GetAccountActivityResponse$instructionsUrl' => '<p> The URL resource that provides guidance on activity requirements and completion. </p>', 'InternalServerException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ThrottlingException$message' => NULL, 'ValidationException$message' => NULL, ], ], 'GetAccountActivityRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAccountActivityResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetAccountPlanStateRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetAccountPlanStateResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetFreeTierUsageRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetFreeTierUsageResponse' => [ 'base' => NULL, 'refs' => [], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'GetAccountActivityResponse$estimatedTimeToCompleteInMinutes' => '<p> The estimated time to complete the activity. This is the duration in minutes. </p>', ], ], 'InternalServerException' => [ 'base' => '<p>An unexpected error occurred during the processing of your request.</p>', 'refs' => [], ], 'LanguageCode' => [ 'base' => NULL, 'refs' => [ 'GetAccountActivityRequest$languageCode' => '<p> The language code used to return translated title and description fields. </p>', 'ListAccountActivitiesRequest$languageCode' => '<p> The language code used to return translated titles. </p>', ], ], 'ListAccountActivitiesRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAccountActivitiesResponse' => [ 'base' => NULL, 'refs' => [], ], 'MatchOption' => [ 'base' => NULL, 'refs' => [ 'MatchOptions$member' => NULL, ], ], 'MatchOptions' => [ 'base' => NULL, 'refs' => [ 'DimensionValues$MatchOptions' => '<p>The match options that you can use to filter your results. You can specify only one of these values in the array.</p>', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'GetFreeTierUsageRequest$maxResults' => '<p>The maximum number of results to return in the response. <code>MaxResults</code> means that there can be up to the specified number of values, but there might be fewer results based on your filters.</p>', 'ListAccountActivitiesRequest$maxResults' => '<p> 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. </p>', ], ], 'MonetaryAmount' => [ 'base' => '<p> The monetary amount of the credit. </p>', 'refs' => [ 'ActivityReward$credit' => '<p> The credits gained by activity rewards. </p>', 'GetAccountPlanStateResponse$accountPlanRemainingCredits' => '<p> The amount of credits remaining for the account. </p>', ], ], 'NextPageToken' => [ 'base' => NULL, 'refs' => [ 'GetFreeTierUsageRequest$nextToken' => '<p>The pagination token that indicates the next set of results to retrieve.</p>', 'GetFreeTierUsageResponse$nextToken' => '<p>The pagination token that indicates the next set of results to retrieve.</p>', 'ListAccountActivitiesRequest$nextToken' => '<p> 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 <code>maxResults</code>. </p>', 'ListAccountActivitiesResponse$nextToken' => '<p> The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return. </p>', ], ], 'ResourceNotFoundException' => [ 'base' => '<p> This exception is thrown when the requested resource cannot be found. </p>', 'refs' => [], ], 'SyntheticTimestamp_date_time' => [ 'base' => NULL, 'refs' => [ 'GetAccountActivityResponse$expiresAt' => '<p> The time by which the activity must be completed to receive a reward. </p>', 'GetAccountActivityResponse$startedAt' => '<p> The timestamp when the activity started. This field appears only for activities in the <code>IN_PROGRESS</code> or <code>COMPLETED</code> states. </p>', 'GetAccountActivityResponse$completedAt' => '<p> The timestamp when the activity is completed. This field appears only for activities in the <code>COMPLETED</code> state. </p>', 'GetAccountPlanStateResponse$accountPlanExpirationDate' => '<p> The timestamp for when the current account plan expires. </p>', ], ], 'ThrottlingException' => [ 'base' => '<p>The request was denied due to request throttling.</p>', 'refs' => [], ], 'UpgradeAccountPlanRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpgradeAccountPlanResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '<p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>', 'refs' => [], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'Values$member' => NULL, ], ], 'Values' => [ 'base' => NULL, 'refs' => [ 'DimensionValues$Values' => '<p>The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.</p>', ], ], ],];
