costexplorer

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 26, 2018 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package costexplorer provides the client and types for making API requests to AWS Cost Explorer Service.

The Cost Explorer API allows you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.

Service Endpoint

The Cost Explorer API provides the following endpoint:

For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing (https://aws.amazon.com/aws-cost-management/pricing/).

See https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25 for more information on this service.

See costexplorer package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/costexplorer/

Using the Client

To AWS Cost Explorer Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Cost Explorer Service client CostExplorer for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/costexplorer/#New

Index

Constants

View Source 
const (

	// ErrCodeBillExpirationException for service response error code
	// "BillExpirationException".
	//
	// The requested report expired. Update the date interval and try again.
	ErrCodeBillExpirationException = "BillExpirationException"

	// ErrCodeDataUnavailableException for service response error code
	// "DataUnavailableException".
	//
	// The requested data is unavailable.
	ErrCodeDataUnavailableException = "DataUnavailableException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The pagination token is invalid. Try again without a pagination token.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// You made too many calls in a short period of time. Try again later.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeRequestChangedException for service response error code
	// "RequestChangedException".
	//
	// Your request parameters changed between pages. Try again with the old parameters
	// or without a pagination token.
	ErrCodeRequestChangedException = "RequestChangedException"
)
View Source 
const (
	ServiceName = "ce"        // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountScope added in v0.4.0 

type AccountScope string
const (
	AccountScopePayer AccountScope = "PAYER"
)

Enum values for AccountScope

func (AccountScope) MarshalValue added in v0.4.0 

func (enum AccountScope) MarshalValue() (string, error)

func (AccountScope) MarshalValueBuf added in v0.4.0 

func (enum AccountScope) MarshalValueBuf(b []byte) ([]byte, error)

type Context 

type Context string
const (
	ContextCostAndUsage Context = "COST_AND_USAGE"
	ContextReservations Context = "RESERVATIONS"
)

Enum values for Context

func (Context) MarshalValue added in v0.3.0 

func (enum Context) MarshalValue() (string, error)

func (Context) MarshalValueBuf added in v0.3.0 

func (enum Context) MarshalValueBuf(b []byte) ([]byte, error)

type CostExplorer 

type CostExplorer struct {
	*aws.Client
}

CostExplorer provides the API operation methods for making requests to AWS Cost Explorer Service. See this package's package overview docs for details on the service.

CostExplorer methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *CostExplorer

New creates a new instance of the CostExplorer client with a config.

Example: 

// Create a CostExplorer client from just a config.
svc := costexplorer.New(myConfig)

func (*CostExplorer) GetCostAndUsageRequest 

func (c *CostExplorer) GetCostAndUsageRequest(input *GetCostAndUsageInput) GetCostAndUsageRequest

GetCostAndUsageRequest returns a request value for making API operation for AWS Cost Explorer Service.

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues (http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html) operation. Master accounts in an organization in AWS Organizations have access to all member accounts. 

// Example sending a request using the GetCostAndUsageRequest method.
req := client.GetCostAndUsageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetCostAndUsage

func (*CostExplorer) GetDimensionValuesRequest 

func (c *CostExplorer) GetDimensionValuesRequest(input *GetDimensionValuesInput) GetDimensionValuesRequest

GetDimensionValuesRequest returns a request value for making API operation for AWS Cost Explorer Service.

Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. 

// Example sending a request using the GetDimensionValuesRequest method.
req := client.GetDimensionValuesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetDimensionValues

func (*CostExplorer) GetReservationCoverageRequest added in v0.3.0 

func (c *CostExplorer) GetReservationCoverageRequest(input *GetReservationCoverageInput) GetReservationCoverageRequest

GetReservationCoverageRequest returns a request value for making API operation for AWS Cost Explorer Service.

Retrieves the reservation coverage for your account. This allows you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • TAG

  • TENANCY

To determine valid values for a dimension, use the GetDimensionValues operation. 

// Example sending a request using the GetReservationCoverageRequest method.
req := client.GetReservationCoverageRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetReservationCoverage

func (*CostExplorer) GetReservationPurchaseRecommendationRequest added in v0.4.0 

func (c *CostExplorer) GetReservationPurchaseRecommendationRequest(input *GetReservationPurchaseRecommendationInput) GetReservationPurchaseRecommendationRequest

GetReservationPurchaseRecommendationRequest returns a request value for making API operation for AWS Cost Explorer Service.

Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.

For example, AWS automatically aggregates your EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large, because that is the smallest size instance in the c4 instance family. 

// Example sending a request using the GetReservationPurchaseRecommendationRequest method.
req := client.GetReservationPurchaseRecommendationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetReservationPurchaseRecommendation

func (*CostExplorer) GetReservationUtilizationRequest 

func (c *CostExplorer) GetReservationUtilizationRequest(input *GetReservationUtilizationInput) GetReservationUtilizationRequest

GetReservationUtilizationRequest returns a request value for making API operation for AWS Cost Explorer Service.

Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID. 

// Example sending a request using the GetReservationUtilizationRequest method.
req := client.GetReservationUtilizationRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetReservationUtilization

func (*CostExplorer) GetTagsRequest 

func (c *CostExplorer) GetTagsRequest(input *GetTagsInput) GetTagsRequest

GetTagsRequest returns a request value for making API operation for AWS Cost Explorer Service.

Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. 

// Example sending a request using the GetTagsRequest method.
req := client.GetTagsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetTags

type Coverage added in v0.3.0 

type Coverage struct {

	// The amount of instance usage that a reservation covered, in hours.
	CoverageHours *CoverageHours `type:"structure"`
	// contains filtered or unexported fields
}

The amount of instance usage that a reservation covered. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/Coverage

func (Coverage) GoString added in v0.3.0 

func (s Coverage) GoString() string

GoString returns the string representation

func (Coverage) String added in v0.3.0 

func (s Coverage) String() string

String returns the string representation

type CoverageByTime added in v0.3.0 

type CoverageByTime struct {

	// The groups of instances that are covered by a reservation.
	Groups []ReservationCoverageGroup `type:"list"`

	// The period over which this coverage was used.
	TimePeriod *DateInterval `type:"structure"`

	// The total reservation coverage, in hours.
	Total *Coverage `type:"structure"`
	// contains filtered or unexported fields
}

Reservation coverage for a specified period, in hours. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/CoverageByTime

func (CoverageByTime) GoString added in v0.3.0 

func (s CoverageByTime) GoString() string

GoString returns the string representation

func (CoverageByTime) String added in v0.3.0 

func (s CoverageByTime) String() string

String returns the string representation

type CoverageHours added in v0.3.0 

type CoverageHours struct {

	// The percentage of instance hours that are covered by a reservation.
	CoverageHoursPercentage *string `type:"string"`

	// The number of instance running hours that are covered by On-Demand Instances.
	OnDemandHours *string `type:"string"`

	// The number of instance running hours that are covered by reservations.
	ReservedHours *string `type:"string"`

	// The total instance usage, in hours.
	TotalRunningHours *string `type:"string"`
	// contains filtered or unexported fields
}

How long a running instance either used a reservation or was On-Demand. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/CoverageHours

func (CoverageHours) GoString added in v0.3.0 

func (s CoverageHours) GoString() string

GoString returns the string representation

func (CoverageHours) String added in v0.3.0 

func (s CoverageHours) String() string

String returns the string representation

type DateInterval 

type DateInterval struct {

	// The end of the time period that you want the usage and costs for. The end
	// date is exclusive. For example, if end is 2017-05-01, AWS retrieves cost
	// and usage data from the start date up to, but not including, 2017-05-01.
	//
	// End is a required field
	End *string `type:"string" required:"true"`

	// The beginning of the time period that you want the usage and costs for. The
	// start date is inclusive. For example, if start is 2017-01-01, AWS retrieves
	// cost and usage data starting at 2017-01-01 up to the end date.
	//
	// Start is a required field
	Start *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The time period that you want the usage and costs for. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/DateInterval

func (DateInterval) GoString 

func (s DateInterval) GoString() string

GoString returns the string representation

func (DateInterval) String 

func (s DateInterval) String() string

String returns the string representation

func (*DateInterval) Validate 

func (s *DateInterval) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Dimension 

type Dimension string
const (
	DimensionAz                 Dimension = "AZ"
	DimensionInstanceType       Dimension = "INSTANCE_TYPE"
	DimensionLinkedAccount      Dimension = "LINKED_ACCOUNT"
	DimensionOperation          Dimension = "OPERATION"
	DimensionPurchaseType       Dimension = "PURCHASE_TYPE"
	DimensionRegion             Dimension = "REGION"
	DimensionService            Dimension = "SERVICE"
	DimensionUsageType          Dimension = "USAGE_TYPE"
	DimensionUsageTypeGroup     Dimension = "USAGE_TYPE_GROUP"
	DimensionRecordType         Dimension = "RECORD_TYPE"
	DimensionOperatingSystem    Dimension = "OPERATING_SYSTEM"
	DimensionTenancy            Dimension = "TENANCY"
	DimensionScope              Dimension = "SCOPE"
	DimensionPlatform           Dimension = "PLATFORM"
	DimensionSubscriptionId     Dimension = "SUBSCRIPTION_ID"
	DimensionLegalEntityName    Dimension = "LEGAL_ENTITY_NAME"
	DimensionDeploymentOption   Dimension = "DEPLOYMENT_OPTION"
	DimensionDatabaseEngine     Dimension = "DATABASE_ENGINE"
	DimensionCacheEngine        Dimension = "CACHE_ENGINE"
	DimensionInstanceTypeFamily Dimension = "INSTANCE_TYPE_FAMILY"
)

Enum values for Dimension

func (Dimension) MarshalValue added in v0.3.0 

func (enum Dimension) MarshalValue() (string, error)

func (Dimension) MarshalValueBuf added in v0.3.0 

func (enum Dimension) MarshalValueBuf(b []byte) ([]byte, error)

type DimensionValues 

type DimensionValues struct {

	// The names of the metadata types that you can use to filter and group your
	// results. For example, AZ returns a list of Availability Zones.
	Key Dimension `type:"string" enum:"true"`

	// The metadata values that you can use to filter and group your results. You
	// can use GetDimensionValues to find specific values.
	Values []string `type:"list"`
	// contains filtered or unexported fields
}

The metadata that you can use to filter and group your results. You can use GetDimensionValues to find specific values. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/DimensionValues

func (DimensionValues) GoString 

func (s DimensionValues) GoString() string

GoString returns the string representation

func (DimensionValues) String 

func (s DimensionValues) String() string

String returns the string representation

type DimensionValuesWithAttributes 

type DimensionValuesWithAttributes struct {

	// The attribute that applies to a specific Dimension.
	Attributes map[string]string `type:"map"`

	// The value of a dimension with a specific attribute.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

The metadata of a specific type that you can use to filter and group your results. You can use GetDimensionValues to find specific values. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/DimensionValuesWithAttributes

func (DimensionValuesWithAttributes) GoString 

func (s DimensionValuesWithAttributes) GoString() string

GoString returns the string representation

func (DimensionValuesWithAttributes) String 

func (s DimensionValuesWithAttributes) String() string

String returns the string representation

type EC2InstanceDetails added in v0.4.0 

type EC2InstanceDetails struct {

	// The Availability Zone of the recommended reservation.
	AvailabilityZone *string `type:"string"`

	// Whether the recommendation is for a current generation instance.
	CurrentGeneration *bool `type:"boolean"`

	// The instance family of the recommended reservation.
	Family *string `type:"string"`

	// The type of instance that AWS recommends.
	InstanceType *string `type:"string"`

	// The platform of the recommended reservation. The platform is the specific
	// combination of operating system, license model, and software on an instance.
	Platform *string `type:"string"`

	// The AWS Region of the recommended reservation.
	Region *string `type:"string"`

	// Whether the recommended reservation is size flexible.
	SizeFlexEligible *bool `type:"boolean"`

	// Whether the recommended reservation is dedicated or shared.
	Tenancy *string `type:"string"`
	// contains filtered or unexported fields
}

Details about the EC2 instances that AWS recommends that you purchase. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/EC2InstanceDetails

func (EC2InstanceDetails) GoString added in v0.4.0 

func (s EC2InstanceDetails) GoString() string

GoString returns the string representation

func (EC2InstanceDetails) String added in v0.4.0 

func (s EC2InstanceDetails) String() string

String returns the string representation

type EC2Specification added in v0.4.0 

type EC2Specification struct {

	// Whether you want a recommendation for standard or convertible reservations.
	OfferingClass OfferingClass `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

The EC2 hardware specifications that you want AWS to provide recommendations for. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/EC2Specification

func (EC2Specification) GoString added in v0.4.0 

func (s EC2Specification) GoString() string

GoString returns the string representation

func (EC2Specification) String added in v0.4.0 

func (s EC2Specification) String() string

String returns the string representation

type Expression 

type Expression struct {

	// Return results that match both Dimension objects.
	And []Expression `type:"list"`

	// The specific Dimension to use for Expression.
	Dimensions *DimensionValues `type:"structure"`

	// Return results that don't match a Dimension object.
	Not *Expression `type:"structure"`

	// Return results that match either Dimension object.
	Or []Expression `type:"list"`

	// The specific Tag to use for Expression.
	Tags *TagValues `type:"structure"`
	// contains filtered or unexported fields
}

Use Expression to filter by cost or by usage. There are two patterns:

  • Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large. The Expression for that looks like this:

{ "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large” 

] } }

The list of dimension values are OR'd together to retrieve cost or usage 

data. You can create Expression and DimensionValues objects using either
with* methods or set* methods in multiple lines.

* Compound dimension values with logical operations - You can use multiple
Expression types and the logical operators AND/OR/NOT to create a list
of one or more Expression objects. This allows you to filter on more advanced
options. For example, you can filter on ((INSTANCE_TYPE == m4.large OR
INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE !=
DataTransfer). The Expression for that looks like this:

{ "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ 

"m4.x.large", "c4.large" ] }}, {"Tag": { "Key": "TagName", "Values": ["Value1"]
} } ]}, {"Not": {"dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"]
}}} ] }

Because each Expression can have only one operator, the service returns an 

  error if more than one is specified. The following example shows an Expression
  object that creates an error.

{ "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values":
  [ "DataTransfer" ] } }

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/Expression

func (Expression) GoString 

func (s Expression) GoString() string

GoString returns the string representation

func (Expression) String 

func (s Expression) String() string

String returns the string representation

type GetCostAndUsageInput 

type GetCostAndUsageInput struct {

	// Filters AWS costs by different dimensions. For example, you can specify SERVICE
	// and LINKED_ACCOUNT and get the costs that are associated with that account's
	// usage of that service. You can nest Expression objects to define any combination
	// of dimension filters. For more information, see Expression (http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html).
	Filter *Expression `type:"structure"`

	// Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set,
	// the response object doesn't include the Granularity, either MONTHLY or DAILY.
	Granularity Granularity `type:"string" enum:"true"`

	// You can group AWS costs using up to two different groups, either dimensions,
	// tag keys, or both.
	//
	// When you group by tag key, you get all tag values, including empty strings.
	//
	// Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION,
	// PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, and USAGE_TYPE.
	GroupBy []GroupDefinition `type:"list"`

	// Which metrics are returned in the query. For more information about blended
	// and unblended rates, see Why does the "blended" annotation appear on some
	// line items in my bill? (https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/).
	//
	// Valid values are BlendedCost, UnblendedCost, and UsageQuantity.
	//
	// If you return the UsageQuantity metric, the service aggregates all usage
	// numbers without taking into account the units. For example, if you aggregate
	// usageQuantity across all of EC2, the results aren't meaningful because EC2
	// compute hours and data transfer are measured in different units (for example,
	// hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType
	// or UsageTypeGroups.
	//
	// Metrics is required for GetCostAndUsage requests.
	Metrics []string `type:"list"`

	// The token to retrieve the next set of results. AWS provides the token when
	// the response from a previous call has more results than the maximum page
	// size.
	NextPageToken *string `type:"string"`

	// Sets the start and end dates for retrieving AWS costs. The start date is
	// inclusive, but the end date is exclusive. For example, if start is 2017-01-01
	// and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01
	// up to and including 2017-04-30 but not including 2017-05-01.
	TimePeriod *DateInterval `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetCostAndUsageRequest

func (GetCostAndUsageInput) GoString 

func (s GetCostAndUsageInput) GoString() string

GoString returns the string representation

func (GetCostAndUsageInput) String 

func (s GetCostAndUsageInput) String() string

String returns the string representation

func (*GetCostAndUsageInput) Validate 

func (s *GetCostAndUsageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetCostAndUsageOutput 

type GetCostAndUsageOutput struct {

	// The groups that are specified by the Filter or GroupBy parameters in the
	// request.
	GroupDefinitions []GroupDefinition `type:"list"`

	// The token for the next set of retrievable results. AWS provides the token
	// when the response from a previous call has more results than the maximum
	// page size.
	NextPageToken *string `type:"string"`

	// The time period that is covered by the results in the response.
	ResultsByTime []ResultByTime `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetCostAndUsageResponse

func (GetCostAndUsageOutput) GoString 

func (s GetCostAndUsageOutput) GoString() string

GoString returns the string representation

func (GetCostAndUsageOutput) SDKResponseMetadata 

func (s GetCostAndUsageOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetCostAndUsageOutput) String 

func (s GetCostAndUsageOutput) String() string

String returns the string representation

type GetCostAndUsageRequest 

type GetCostAndUsageRequest struct {
	*aws.Request
	Input *GetCostAndUsageInput
	Copy  func(*GetCostAndUsageInput) GetCostAndUsageRequest
}

GetCostAndUsageRequest is a API request type for the GetCostAndUsage API operation.

func (GetCostAndUsageRequest) Send 

func (r GetCostAndUsageRequest) Send() (*GetCostAndUsageOutput, error)

Send marshals and sends the GetCostAndUsage API request.

type GetDimensionValuesInput 

type GetDimensionValuesInput struct {

	// The context for the call to GetDimensionValues. This can be RESERVATIONS
	// or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is
	// set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization
	// operation. If the context is set to COST_AND_USAGE the resulting dimension
	// values can be used in the GetCostAndUsage operation.
	//
	// If you set the context to COST_AND_USAGE, you can use the following dimensions
	// for searching:
	//
	//    * AZ - The Availability Zone. An example is us-east-1a.
	//
	//    * DATABASE_ENGINE - The Amazon Relational Database Service database. Examples
	//    are Aurora or MySQL.
	//
	//    * INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
	//
	//    * LEGAL_ENTITY_NAME - The name of the organization that sells you AWS
	//    services, such as Amazon Web Services.
	//
	//    * LINKED_ACCOUNT - The description in the attribute map that includes
	//    the full name of the member account. The value field contains the AWS
	//    ID of the member account.
	//
	//    * OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
	//
	//    * OPERATION - The action performed. Examples include RunInstance and CreateBucket.
	//
	//    * PLATFORM - The EC2 operating system. Examples are Windows or Linux.
	//
	//    * PURCHASE_TYPE - The reservation type of the purchase to which this usage
	//    is related. Examples include On-Demand Instances and Standard Reserved
	//    Instances.
	//
	//    * SERVICE - The AWS service such as Amazon DynamoDB.
	//
	//    * USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes.
	//    The response for the GetDimensionValues operation includes a unit attribute.
	//    Examples include GB and Hrs.
	//
	//    * USAGE_TYPE_GROUP - The grouping of common usage types. An example is
	//    EC2: CloudWatch – Alarms. The response for this operation includes a unit
	//    attribute.
	//
	//    * RECORD_TYPE - The different types of charges such as RI fees, usage
	//    costs, tax refunds, and credits.
	//
	// If you set the context to RESERVATIONS, you can use the following dimensions
	// for searching:
	//
	//    * AZ - The Availability Zone. An example is us-east-1a.
	//
	//    * CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are
	//    Windows or Linux.
	//
	//    * DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service
	//    deployments. Valid values are SingleAZ and MultiAZ.
	//
	//    * INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
	//
	//    * LINKED_ACCOUNT - The description in the attribute map that includes
	//    the full name of the member account. The value field contains the AWS
	//    ID of the member account.
	//
	//    * PLATFORM - The EC2 operating system. Examples are Windows or Linux.
	//
	//    * REGION - The AWS Region.
	//
	//    * SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values
	//    are regional or a single Availability Zone.
	//
	//    * TAG (Coverage only) - The tags that are associated with a Reserved Instance
	//    (RI).
	//
	//    * TENANCY - The tenancy of a resource. Examples are shared or dedicated.
	Context Context `type:"string" enum:"true"`

	// The name of the dimension. Each Dimension is available for different a Context.
	// For more information, see Context.
	//
	// Dimension is a required field
	Dimension Dimension `type:"string" required:"true" enum:"true"`

	// The token to retrieve the next set of results. AWS provides the token when
	// the response from a previous call has more results than the maximum page
	// size.
	NextPageToken *string `type:"string"`

	// The value that you want to search the filter values for.
	SearchString *string `type:"string"`

	// The start and end dates for retrieving the dimension values. The start date
	// is inclusive, but the end date is exclusive. For example, if start is 2017-01-01
	// and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01
	// up to and including 2017-04-30 but not including 2017-05-01.
	//
	// TimePeriod is a required field
	TimePeriod *DateInterval `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetDimensionValuesRequest

func (GetDimensionValuesInput) GoString 

func (s GetDimensionValuesInput) GoString() string

GoString returns the string representation

func (GetDimensionValuesInput) String 

func (s GetDimensionValuesInput) String() string

String returns the string representation

func (*GetDimensionValuesInput) Validate 

func (s *GetDimensionValuesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDimensionValuesOutput 

type GetDimensionValuesOutput struct {

	// The filters that you used to filter your request. Some dimensions are available
	// only for a specific context:
	//
	// If you set the context to COST_AND_USAGE, you can use the following dimensions
	// for searching:
	//
	//    * AZ - The Availability Zone. An example is us-east-1a.
	//
	//    * DATABASE_ENGINE - The Amazon Relational Database Service database. Examples
	//    are Aurora or MySQL.
	//
	//    * INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
	//
	//    * LEGAL_ENTITY_NAME - The name of the organization that sells you AWS
	//    services, such as Amazon Web Services.
	//
	//    * LINKED_ACCOUNT - The description in the attribute map that includes
	//    the full name of the member account. The value field contains the AWS
	//    ID of the member account.
	//
	//    * OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
	//
	//    * OPERATION - The action performed. Examples include RunInstance and CreateBucket.
	//
	//    * PLATFORM - The EC2 operating system. Examples are Windows or Linux.
	//
	//    * PURCHASE_TYPE - The reservation type of the purchase to which this usage
	//    is related. Examples include On-Demand Instances and Standard Reserved
	//    Instances.
	//
	//    * SERVICE - The AWS service such as Amazon DynamoDB.
	//
	//    * USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes.
	//    The response for the GetDimensionValues operation includes a unit attribute.
	//    Examples include GB and Hrs.
	//
	//    * USAGE_TYPE_GROUP - The grouping of common usage types. An example is
	//    EC2: CloudWatch – Alarms. The response for this operation includes a unit
	//    attribute.
	//
	//    * RECORD_TYPE - The different types of charges such as RI fees, usage
	//    costs, tax refunds, and credits.
	//
	// If you set the context to RESERVATIONS, you can use the following dimensions
	// for searching:
	//
	//    * AZ - The Availability Zone. An example is us-east-1a.
	//
	//    * CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are
	//    Windows or Linux.
	//
	//    * DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service
	//    deployments. Valid values are SingleAZ and MultiAZ.
	//
	//    * INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.
	//
	//    * LINKED_ACCOUNT - The description in the attribute map that includes
	//    the full name of the member account. The value field contains the AWS
	//    ID of the member account.
	//
	//    * PLATFORM - The EC2 operating system. Examples are Windows or Linux.
	//
	//    * REGION - The AWS Region.
	//
	//    * SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values
	//    are regional or a single Availability Zone.
	//
	//    * TAG (Coverage only) - The tags that are associated with a Reserved Instance
	//    (RI).
	//
	//    * TENANCY - The tenancy of a resource. Examples are shared or dedicated.
	//
	// DimensionValues is a required field
	DimensionValues []DimensionValuesWithAttributes `type:"list" required:"true"`

	// The token for the next set of retrievable results. AWS provides the token
	// when the response from a previous call has more results than the maximum
	// page size.
	NextPageToken *string `type:"string"`

	// The number of results that AWS returned at one time.
	//
	// ReturnSize is a required field
	ReturnSize *int64 `type:"integer" required:"true"`

	// The total number of search results.
	//
	// TotalSize is a required field
	TotalSize *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetDimensionValuesResponse

func (GetDimensionValuesOutput) GoString 

func (s GetDimensionValuesOutput) GoString() string

GoString returns the string representation

func (GetDimensionValuesOutput) SDKResponseMetadata 

func (s GetDimensionValuesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetDimensionValuesOutput) String 

func (s GetDimensionValuesOutput) String() string

String returns the string representation

type GetDimensionValuesRequest 

type GetDimensionValuesRequest struct {
	*aws.Request
	Input *GetDimensionValuesInput
	Copy  func(*GetDimensionValuesInput) GetDimensionValuesRequest
}

GetDimensionValuesRequest is a API request type for the GetDimensionValues API operation.

func (GetDimensionValuesRequest) Send 

func (r GetDimensionValuesRequest) Send() (*GetDimensionValuesOutput, error)

Send marshals and sends the GetDimensionValues API request.

type GetReservationCoverageInput added in v0.3.0 

type GetReservationCoverageInput struct {

	// Filters utilization data by dimensions. You can filter by the following dimensions:
	//
	//    * AZ
	//
	//    * CACHE_ENGINE
	//
	//    * DATABASE_ENGINE
	//
	//    * DEPLOYMENT_OPTION
	//
	//    * INSTANCE_TYPE
	//
	//    * LINKED_ACCOUNT
	//
	//    * OPERATING_SYSTEM
	//
	//    * PLATFORM
	//
	//    * REGION
	//
	//    * SERVICE
	//
	//    * TAG
	//
	//    * TENANCY
	//
	// GetReservationCoverage uses the same Expression (http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html)
	// object as the other operations, but only AND is supported among each dimension.
	// You can nest only one level deep. If there are multiple values for a dimension,
	// they are OR'd together.
	Filter *Expression `type:"structure"`

	// The granularity of the AWS cost data for the reservation. Valid values are
	// MONTHLY and DAILY.
	//
	// If GroupBy is set, Granularity can't be set. If Granularity isn't set, the
	// response object doesn't include Granularity, either MONTHLY or DAILY.
	Granularity Granularity `type:"string" enum:"true"`

	// You can group the data by the following attributes:
	//
	//    * AZ
	//
	//    * CACHE_ENGINE
	//
	//    * DATABASE_ENGINE
	//
	//    * DEPLOYMENT_OPTION
	//
	//    * INSTANCE_TYPE
	//
	//    * LINKED_ACCOUNT
	//
	//    * OPERATING_SYSTEM
	//
	//    * PLATFORM
	//
	//    * REGION
	//
	//    * TAG
	//
	//    * TENANCY
	GroupBy []GroupDefinition `type:"list"`

	// The token to retrieve the next set of results. AWS provides the token when
	// the response from a previous call has more results than the maximum page
	// size.
	NextPageToken *string `type:"string"`

	// The start and end dates of the period for which you want to retrieve data
	// about reservation coverage. You can retrieve data for a maximum of 13 months:
	// the last 12 months and the current month. The start date is inclusive, but
	// the end date is exclusive. For example, if start is 2017-01-01 and end is
	// 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up
	// to and including 2017-04-30 but not including 2017-05-01.
	//
	// TimePeriod is a required field
	TimePeriod *DateInterval `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

You can use the following request parameters to query for how much of your instance usage is covered by a reservation. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetReservationCoverageRequest

func (GetReservationCoverageInput) GoString added in v0.3.0 

func (s GetReservationCoverageInput) GoString() string

GoString returns the string representation

func (GetReservationCoverageInput) String added in v0.3.0 

func (s GetReservationCoverageInput) String() string

String returns the string representation

func (*GetReservationCoverageInput) Validate added in v0.3.0 

func (s *GetReservationCoverageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetReservationCoverageOutput added in v0.3.0 

type GetReservationCoverageOutput struct {

	// The amount of time that your reservations covered.
	//
	// CoveragesByTime is a required field
	CoveragesByTime []CoverageByTime `type:"list" required:"true"`

	// The token for the next set of retrievable results. AWS provides the token
	// when the response from a previous call has more results than the maximum
	// page size.
	NextPageToken *string `type:"string"`

	// The total amount of instance usage that is covered by a reservation.
	Total *Coverage `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetReservationCoverageResponse

func (GetReservationCoverageOutput) GoString added in v0.3.0 

func (s GetReservationCoverageOutput) GoString() string

GoString returns the string representation

func (GetReservationCoverageOutput) SDKResponseMetadata added in v0.3.0 

func (s GetReservationCoverageOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetReservationCoverageOutput) String added in v0.3.0 

func (s GetReservationCoverageOutput) String() string

String returns the string representation

type GetReservationCoverageRequest added in v0.3.0 

type GetReservationCoverageRequest struct {
	*aws.Request
	Input *GetReservationCoverageInput
	Copy  func(*GetReservationCoverageInput) GetReservationCoverageRequest
}

GetReservationCoverageRequest is a API request type for the GetReservationCoverage API operation.

func (GetReservationCoverageRequest) Send added in v0.3.0 

func (r GetReservationCoverageRequest) Send() (*GetReservationCoverageOutput, error)

Send marshals and sends the GetReservationCoverage API request.

type GetReservationPurchaseRecommendationInput added in v0.4.0 

type GetReservationPurchaseRecommendationInput struct {

	// The account ID that is associated with the recommendation.
	AccountId *string `type:"string"`

	// The account scope that you want recommendations for. The only valid value
	// is Payer. This means that AWS includes the master account and any member
	// accounts when it calculates its recommendations.
	AccountScope AccountScope `type:"string" enum:"true"`

	// The number of previous days that you want AWS to consider when it calculates
	// your recommendations.
	LookbackPeriodInDays LookbackPeriodInDays `type:"string" enum:"true"`

	// The pagination token that indicates the next set of results that you want
	// to retrieve.
	NextPageToken *string `type:"string"`

	// The number of recommendations that you want returned in a single response
	// object.
	PageSize *int64 `type:"integer"`

	// The reservation purchase option that you want recommendations for.
	PaymentOption PaymentOption `type:"string" enum:"true"`

	// The specific service that you want recommendations for.
	//
	// Service is a required field
	Service *string `type:"string" required:"true"`

	// The hardware specifications for the service instances that you want recommendations
	// for, such as standard or convertible EC2 instances.
	ServiceSpecification *ServiceSpecification `type:"structure"`

	// The reservation term that you want recommendations for.
	TermInYears TermInYears `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetReservationPurchaseRecommendationRequest

func (GetReservationPurchaseRecommendationInput) GoString added in v0.4.0 

func (s GetReservationPurchaseRecommendationInput) GoString() string

GoString returns the string representation

func (GetReservationPurchaseRecommendationInput) String added in v0.4.0 

func (s GetReservationPurchaseRecommendationInput) String() string

String returns the string representation

func (*GetReservationPurchaseRecommendationInput) Validate added in v0.4.0 

func (s *GetReservationPurchaseRecommendationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetReservationPurchaseRecommendationOutput added in v0.4.0 

type GetReservationPurchaseRecommendationOutput struct {

	// Information about this specific recommendation call, such as the time stamp
	// for when Cost Explorer generated this recommendation.
	Metadata *ReservationPurchaseRecommendationMetadata `type:"structure"`

	// The pagination token for the next set of retrievable results.
	NextPageToken *string `type:"string"`

	// Recommendations for reservations to purchase.
	Recommendations []ReservationPurchaseRecommendation `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetReservationPurchaseRecommendationResponse

func (GetReservationPurchaseRecommendationOutput) GoString added in v0.4.0 

func (s GetReservationPurchaseRecommendationOutput) GoString() string

GoString returns the string representation

func (GetReservationPurchaseRecommendationOutput) SDKResponseMetadata added in v0.4.0 

func (s GetReservationPurchaseRecommendationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetReservationPurchaseRecommendationOutput) String added in v0.4.0 

func (s GetReservationPurchaseRecommendationOutput) String() string

String returns the string representation

type GetReservationPurchaseRecommendationRequest added in v0.4.0 

type GetReservationPurchaseRecommendationRequest struct {
	*aws.Request
	Input *GetReservationPurchaseRecommendationInput
	Copy  func(*GetReservationPurchaseRecommendationInput) GetReservationPurchaseRecommendationRequest
}

GetReservationPurchaseRecommendationRequest is a API request type for the GetReservationPurchaseRecommendation API operation.

func (GetReservationPurchaseRecommendationRequest) Send added in v0.4.0 

func (r GetReservationPurchaseRecommendationRequest) Send() (*GetReservationPurchaseRecommendationOutput, error)

Send marshals and sends the GetReservationPurchaseRecommendation API request.

type GetReservationUtilizationInput 

type GetReservationUtilizationInput struct {

	// Filters utilization data by dimensions. You can filter by the following dimensions:
	//
	//    * AZ
	//
	//    * CACHE_ENGINE
	//
	//    * DATABASE_ENGINE
	//
	//    * DEPLOYMENT_OPTION
	//
	//    * INSTANCE_TYPE
	//
	//    * LINKED_ACCOUNT
	//
	//    * OPERATING_SYSTEM
	//
	//    * PLATFORM
	//
	//    * REGION
	//
	//    * SERVICE
	//
	//    * SCOPE
	//
	//    * TENANCY
	//
	// GetReservationUtilization uses the same Expression (http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html)
	// object as the other operations, but only AND is supported among each dimension,
	// and nesting is supported up to only one level deep. If there are multiple
	// values for a dimension, they are OR'd together.
	Filter *Expression `type:"structure"`

	// If GroupBy is set, Granularity can't be set. If Granularity isn't set, the
	// response object doesn't include Granularity, either MONTHLY or DAILY. If
	// both GroupBy and Granularity aren't set, GetReservationUtilization defaults
	// to DAILY.
	Granularity Granularity `type:"string" enum:"true"`

	// Groups only by SUBSCRIPTION_ID. Metadata is included.
	GroupBy []GroupDefinition `type:"list"`

	// The token to retrieve the next set of results. AWS provides the token when
	// the response from a previous call has more results than the maximum page
	// size.
	NextPageToken *string `type:"string"`

	// Sets the start and end dates for retrieving Reserved Instance (RI) utilization.
	// The start date is inclusive, but the end date is exclusive. For example,
	// if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data
	// is retrieved from 2017-01-01 up to and including 2017-04-30 but not including
	// 2017-05-01.
	//
	// TimePeriod is a required field
	TimePeriod *DateInterval `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetReservationUtilizationRequest

func (GetReservationUtilizationInput) GoString 

func (s GetReservationUtilizationInput) GoString() string

GoString returns the string representation

func (GetReservationUtilizationInput) String 

func (s GetReservationUtilizationInput) String() string

String returns the string representation

func (*GetReservationUtilizationInput) Validate 

func (s *GetReservationUtilizationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetReservationUtilizationOutput 

type GetReservationUtilizationOutput struct {

	// The token for the next set of retrievable results. AWS provides the token
	// when the response from a previous call has more results than the maximum
	// page size.
	NextPageToken *string `type:"string"`

	// The total amount of time that you utilized your RIs.
	Total *ReservationAggregates `type:"structure"`

	// The amount of time that you utilized your RIs.
	//
	// UtilizationsByTime is a required field
	UtilizationsByTime []UtilizationByTime `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetReservationUtilizationResponse

func (GetReservationUtilizationOutput) GoString 

func (s GetReservationUtilizationOutput) GoString() string

GoString returns the string representation

func (GetReservationUtilizationOutput) SDKResponseMetadata 

func (s GetReservationUtilizationOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetReservationUtilizationOutput) String 

func (s GetReservationUtilizationOutput) String() string

String returns the string representation

type GetReservationUtilizationRequest 

type GetReservationUtilizationRequest struct {
	*aws.Request
	Input *GetReservationUtilizationInput
	Copy  func(*GetReservationUtilizationInput) GetReservationUtilizationRequest
}

GetReservationUtilizationRequest is a API request type for the GetReservationUtilization API operation.

func (GetReservationUtilizationRequest) Send 

func (r GetReservationUtilizationRequest) Send() (*GetReservationUtilizationOutput, error)

Send marshals and sends the GetReservationUtilization API request.

type GetTagsInput 

type GetTagsInput struct {

	// The token to retrieve the next set of results. AWS provides the token when
	// the response from a previous call has more results than the maximum page
	// size.
	NextPageToken *string `type:"string"`

	// The value that you want to search for.
	SearchString *string `type:"string"`

	// The key of the tag that you want to return values for.
	TagKey *string `type:"string"`

	// The start and end dates for retrieving the dimension values. The start date
	// is inclusive, but the end date is exclusive. For example, if start is 2017-01-01
	// and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01
	// up to and including 2017-04-30 but not including 2017-05-01.
	//
	// TimePeriod is a required field
	TimePeriod *DateInterval `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetTagsRequest

func (GetTagsInput) GoString 

func (s GetTagsInput) GoString() string

GoString returns the string representation

func (GetTagsInput) String 

func (s GetTagsInput) String() string

String returns the string representation

func (*GetTagsInput) Validate 

func (s *GetTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetTagsOutput 

type GetTagsOutput struct {

	// The token for the next set of retrievable results. AWS provides the token
	// when the response from a previous call has more results than the maximum
	// page size.
	NextPageToken *string `type:"string"`

	// The number of query results that AWS returns at a time.
	//
	// ReturnSize is a required field
	ReturnSize *int64 `type:"integer" required:"true"`

	// The tags that match your request.
	//
	// Tags is a required field
	Tags []string `type:"list" required:"true"`

	// The total number of query results.
	//
	// TotalSize is a required field
	TotalSize *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetTagsResponse

func (GetTagsOutput) GoString 

func (s GetTagsOutput) GoString() string

GoString returns the string representation

func (GetTagsOutput) SDKResponseMetadata 

func (s GetTagsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetTagsOutput) String 

func (s GetTagsOutput) String() string

String returns the string representation

type GetTagsRequest 

type GetTagsRequest struct {
	*aws.Request
	Input *GetTagsInput
	Copy  func(*GetTagsInput) GetTagsRequest
}

GetTagsRequest is a API request type for the GetTags API operation.

func (GetTagsRequest) Send 

func (r GetTagsRequest) Send() (*GetTagsOutput, error)

Send marshals and sends the GetTags API request.

type Granularity 

type Granularity string
const (
	GranularityDaily   Granularity = "DAILY"
	GranularityMonthly Granularity = "MONTHLY"
)

Enum values for Granularity

func (Granularity) MarshalValue added in v0.3.0 

func (enum Granularity) MarshalValue() (string, error)

func (Granularity) MarshalValueBuf added in v0.3.0 

func (enum Granularity) MarshalValueBuf(b []byte) ([]byte, error)

type Group 

type Group struct {

	// The keys that are included in this group.
	Keys []string `type:"list"`

	// The metrics that are included in this group.
	Metrics map[string]MetricValue `type:"map"`
	// contains filtered or unexported fields
}

One level of grouped data within the results. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/Group

func (Group) GoString 

func (s Group) GoString() string

GoString returns the string representation

func (Group) String 

func (s Group) String() string

String returns the string representation

type GroupDefinition 

type GroupDefinition struct {

	// The string that represents a key for a specified group.
	Key *string `type:"string"`

	// The string that represents the type of group.
	Type GroupDefinitionType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GroupDefinition

func (GroupDefinition) GoString 

func (s GroupDefinition) GoString() string

GoString returns the string representation

func (GroupDefinition) String 

func (s GroupDefinition) String() string

String returns the string representation

type GroupDefinitionType 

type GroupDefinitionType string
const (
	GroupDefinitionTypeDimension GroupDefinitionType = "DIMENSION"
	GroupDefinitionTypeTag       GroupDefinitionType = "TAG"
)

Enum values for GroupDefinitionType

func (GroupDefinitionType) MarshalValue added in v0.3.0 

func (enum GroupDefinitionType) MarshalValue() (string, error)

func (GroupDefinitionType) MarshalValueBuf added in v0.3.0 

func (enum GroupDefinitionType) MarshalValueBuf(b []byte) ([]byte, error)

type InstanceDetails added in v0.4.0 

type InstanceDetails struct {

	// The EC2 instances that AWS recommends that you purchase.
	EC2InstanceDetails *EC2InstanceDetails `type:"structure"`

	// The RDS instances that AWS recommends that you purchase.
	RDSInstanceDetails *RDSInstanceDetails `type:"structure"`
	// contains filtered or unexported fields
}

Details about the instances that AWS recommends that you purchase. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/InstanceDetails

func (InstanceDetails) GoString added in v0.4.0 

func (s InstanceDetails) GoString() string

GoString returns the string representation

func (InstanceDetails) String added in v0.4.0 

func (s InstanceDetails) String() string

String returns the string representation

type LookbackPeriodInDays added in v0.4.0 

type LookbackPeriodInDays string
const (
	LookbackPeriodInDaysSevenDays  LookbackPeriodInDays = "SEVEN_DAYS"
	LookbackPeriodInDaysThirtyDays LookbackPeriodInDays = "THIRTY_DAYS"
	LookbackPeriodInDaysSixtyDays  LookbackPeriodInDays = "SIXTY_DAYS"
)

Enum values for LookbackPeriodInDays

func (LookbackPeriodInDays) MarshalValue added in v0.4.0 

func (enum LookbackPeriodInDays) MarshalValue() (string, error)

func (LookbackPeriodInDays) MarshalValueBuf added in v0.4.0 

func (enum LookbackPeriodInDays) MarshalValueBuf(b []byte) ([]byte, error)

type MetricValue 

type MetricValue struct {

	// The actual number that represents the metric.
	Amount *string `type:"string"`

	// The unit that the metric is given in.
	Unit *string `type:"string"`
	// contains filtered or unexported fields
}

The aggregated value for a metric. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/MetricValue

func (MetricValue) GoString 

func (s MetricValue) GoString() string

GoString returns the string representation

func (MetricValue) String 

func (s MetricValue) String() string

String returns the string representation

type OfferingClass added in v0.4.0 

type OfferingClass string
const (
	OfferingClassStandard    OfferingClass = "STANDARD"
	OfferingClassConvertible OfferingClass = "CONVERTIBLE"
)

Enum values for OfferingClass

func (OfferingClass) MarshalValue added in v0.4.0 

func (enum OfferingClass) MarshalValue() (string, error)

func (OfferingClass) MarshalValueBuf added in v0.4.0 

func (enum OfferingClass) MarshalValueBuf(b []byte) ([]byte, error)

type PaymentOption added in v0.4.0 

type PaymentOption string
const (
	PaymentOptionNoUpfront      PaymentOption = "NO_UPFRONT"
	PaymentOptionPartialUpfront PaymentOption = "PARTIAL_UPFRONT"
	PaymentOptionAllUpfront     PaymentOption = "ALL_UPFRONT"
)

Enum values for PaymentOption

func (PaymentOption) MarshalValue added in v0.4.0 

func (enum PaymentOption) MarshalValue() (string, error)

func (PaymentOption) MarshalValueBuf added in v0.4.0 

func (enum PaymentOption) MarshalValueBuf(b []byte) ([]byte, error)

type RDSInstanceDetails added in v0.4.0 

type RDSInstanceDetails struct {

	// Whether the recommendation is for a current generation instance.
	CurrentGeneration *bool `type:"boolean"`

	// The database engine that the recommended reservation supports.
	DatabaseEngine *string `type:"string"`

	// Whether the recommendation is for a reservation in a single availability
	// zone or a reservation with a backup in a second availability zone.
	DeploymentOption *string `type:"string"`

	// The instance family of the recommended reservation.
	Family *string `type:"string"`

	// The type of instance that AWS recommends.
	InstanceType *string `type:"string"`

	// The license model that the recommended reservation supports.
	LicenseModel *string `type:"string"`

	// The AWS Region of the recommended reservation.
	Region *string `type:"string"`

	// Whether the recommended reservation is size flexible.
	SizeFlexEligible *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Details about the RDS instances that AWS recommends that you purchase. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/RDSInstanceDetails

func (RDSInstanceDetails) GoString added in v0.4.0 

func (s RDSInstanceDetails) GoString() string

GoString returns the string representation

func (RDSInstanceDetails) String added in v0.4.0 

func (s RDSInstanceDetails) String() string

String returns the string representation

type ReservationAggregates 

type ReservationAggregates struct {

	// How many RI hours that you purchased.
	PurchasedHours *string `type:"string"`

	// The total number of RI hours that you used.
	TotalActualHours *string `type:"string"`

	// The number of RI hours that you didn't use.
	UnusedHours *string `type:"string"`

	// The percentage of RI time that you used.
	UtilizationPercentage *string `type:"string"`
	// contains filtered or unexported fields
}

The aggregated numbers for your RI usage. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ReservationAggregates

func (ReservationAggregates) GoString 

func (s ReservationAggregates) GoString() string

GoString returns the string representation

func (ReservationAggregates) String 

func (s ReservationAggregates) String() string

String returns the string representation

type ReservationCoverageGroup added in v0.3.0 

type ReservationCoverageGroup struct {

	// The attributes for this group of reservations.
	Attributes map[string]string `type:"map"`

	// How much instance usage this group of reservations covered.
	Coverage *Coverage `type:"structure"`
	// contains filtered or unexported fields
}

A group of reservations that share a set of attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ReservationCoverageGroup

func (ReservationCoverageGroup) GoString added in v0.3.0 

func (s ReservationCoverageGroup) GoString() string

GoString returns the string representation

func (ReservationCoverageGroup) String added in v0.3.0 

func (s ReservationCoverageGroup) String() string

String returns the string representation

type ReservationPurchaseRecommendation added in v0.4.0 

type ReservationPurchaseRecommendation struct {

	// The account scope that AWS recommends that you purchase this instance for.
	// For example, you can purchase this reservation for an entire organization
	// in AWS Organizations.
	AccountScope AccountScope `type:"string" enum:"true"`

	// How many days of previous usage that AWS takes into consideration when making
	// this recommendation.
	LookbackPeriodInDays LookbackPeriodInDays `type:"string" enum:"true"`

	// The payment option for the reservation. For example, AllUpfront or NoUpfront.
	PaymentOption PaymentOption `type:"string" enum:"true"`

	// Details about the recommended purchases.
	RecommendationDetails []ReservationPurchaseRecommendationDetail `type:"list"`

	// A summary about the recommended purchase.
	RecommendationSummary *ReservationPurchaseRecommendationSummary `type:"structure"`

	// Hardware specifications for the service that you want recommendations for.
	ServiceSpecification *ServiceSpecification `type:"structure"`

	// The term of the reservation that you want recommendations for, in years.
	TermInYears TermInYears `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

A specific reservation that AWS recommends for purchase. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ReservationPurchaseRecommendation

func (ReservationPurchaseRecommendation) GoString added in v0.4.0 

func (s ReservationPurchaseRecommendation) GoString() string

GoString returns the string representation

func (ReservationPurchaseRecommendation) String added in v0.4.0 

func (s ReservationPurchaseRecommendation) String() string

String returns the string representation

type ReservationPurchaseRecommendationDetail added in v0.4.0 

type ReservationPurchaseRecommendationDetail struct {

	// The average number of normalized units that you used in an hour during the
	// historical period. AWS uses this to calculate your recommended reservation
	// purchases.
	AverageNormalizedUnitsUsedPerHour *string `type:"string"`

	// The average number of instances that you used in an hour during the historical
	// period. AWS uses this to calculate your recommended reservation purchases.
	AverageNumberOfInstancesUsedPerHour *string `type:"string"`

	// The average utilization of your instances. AWS uses this to calculate your
	// recommended reservation purchases.
	AverageUtilization *string `type:"string"`

	// The currency code that AWS used to calculate the costs for this instance.
	CurrencyCode *string `type:"string"`

	// How long AWS estimates that it takes for this instance to start saving you
	// money, in months.
	EstimatedBreakEvenInMonths *string `type:"string"`

	// How much AWS estimates that you spend on On-Demand Instances in a month.
	EstimatedMonthlyOnDemandCost *string `type:"string"`

	// How much AWS estimates that this specific recommendation could save you in
	// a month.
	EstimatedMonthlySavingsAmount *string `type:"string"`

	// How much AWS estimates that this specific recommendation could save you in
	// a month, as a percentage of your overall costs.
	EstimatedMonthlySavingsPercentage *string `type:"string"`

	// How much AWS estimates that you would have spent for all usage during the
	// specified historical period if you had had a reservation.
	EstimatedReservationCostForLookbackPeriod *string `type:"string"`

	// Details about the instances that AWS recommends that you purchase.
	InstanceDetails *InstanceDetails `type:"structure"`

	// The maximum number of normalized units that you used in an hour during the
	// historical period. AWS uses this to calculate your recommended reservation
	// purchases.
	MaximumNormalizedUnitsUsedPerHour *string `type:"string"`

	// The maximum number of instances that you used in an hour during the historical
	// period. AWS uses this to calculate your recommended reservation purchases.
	MaximumNumberOfInstancesUsedPerHour *string `type:"string"`

	// The minimum number of hours that you used in an hour during the historical
	// period. AWS uses this to calculate your recommended reservation purchases.
	MinimumNormalizedUnitsUsedPerHour *string `type:"string"`

	// The minimum number of instances that you used in an hour during the historical
	// period. AWS uses this to calculate your recommended reservation purchases.
	MinimumNumberOfInstancesUsedPerHour *string `type:"string"`

	// The number of normalized units that AWS recommends that you purchase.
	RecommendedNormalizedUnitsToPurchase *string `type:"string"`

	// The number of instances that AWS recommends that you purchase.
	RecommendedNumberOfInstancesToPurchase *string `type:"string"`

	// How much purchasing this instance costs you on a monthly basis.
	RecurringStandardMonthlyCost *string `type:"string"`

	// How much purchasing this instance costs you upfront.
	UpfrontCost *string `type:"string"`
	// contains filtered or unexported fields
}

Details about your recommended reservation purchase. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ReservationPurchaseRecommendationDetail

func (ReservationPurchaseRecommendationDetail) GoString added in v0.4.0 

func (s ReservationPurchaseRecommendationDetail) GoString() string

GoString returns the string representation

func (ReservationPurchaseRecommendationDetail) String added in v0.4.0 

func (s ReservationPurchaseRecommendationDetail) String() string

String returns the string representation

type ReservationPurchaseRecommendationMetadata added in v0.4.0 

type ReservationPurchaseRecommendationMetadata struct {

	// The time stamp for when AWS made this recommendation.
	GenerationTimestamp *string `type:"string"`

	// The ID for this specific recommendation.
	RecommendationId *string `type:"string"`
	// contains filtered or unexported fields
}

Information about this specific recommendation, such as the time stamp for when AWS made a specific recommendation. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ReservationPurchaseRecommendationMetadata

func (ReservationPurchaseRecommendationMetadata) GoString added in v0.4.0 

func (s ReservationPurchaseRecommendationMetadata) GoString() string

GoString returns the string representation

func (ReservationPurchaseRecommendationMetadata) String added in v0.4.0 

func (s ReservationPurchaseRecommendationMetadata) String() string

String returns the string representation

type ReservationPurchaseRecommendationSummary added in v0.4.0 

type ReservationPurchaseRecommendationSummary struct {

	// The currency code used for this recommendation.
	CurrencyCode *string `type:"string"`

	// The total amount that AWS estimates that this recommendation could save you
	// in a month.
	TotalEstimatedMonthlySavingsAmount *string `type:"string"`

	// The total amount that AWS estimates that this recommendation could save you
	// in a month, as a percentage of your costs.
	TotalEstimatedMonthlySavingsPercentage *string `type:"string"`
	// contains filtered or unexported fields
}

A summary about this recommendation, such as the currency code, the amount that AWS estimates you could save, and the total amount of reservation to purchase. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ReservationPurchaseRecommendationSummary

func (ReservationPurchaseRecommendationSummary) GoString added in v0.4.0 

func (s ReservationPurchaseRecommendationSummary) GoString() string

GoString returns the string representation

func (ReservationPurchaseRecommendationSummary) String added in v0.4.0 

func (s ReservationPurchaseRecommendationSummary) String() string

String returns the string representation

type ReservationUtilizationGroup 

type ReservationUtilizationGroup struct {

	// The attributes for this group of RIs.
	Attributes map[string]string `type:"map"`

	// The key for a specific RI attribute.
	Key *string `type:"string"`

	// How much you used this group of RIs.
	Utilization *ReservationAggregates `type:"structure"`

	// The value of a specific RI attribute.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A group of RIs that share a set of attributes. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ReservationUtilizationGroup

func (ReservationUtilizationGroup) GoString 

func (s ReservationUtilizationGroup) GoString() string

GoString returns the string representation

func (ReservationUtilizationGroup) String 

func (s ReservationUtilizationGroup) String() string

String returns the string representation

type ResultByTime 

type ResultByTime struct {

	// Whether this result is estimated.
	Estimated *bool `type:"boolean"`

	// The groups that are included in this time period.
	Groups []Group `type:"list"`

	// The time period covered by a result.
	TimePeriod *DateInterval `type:"structure"`

	// The total amount of cost or usage accrued during the time period.
	Total map[string]MetricValue `type:"map"`
	// contains filtered or unexported fields
}

The result that is associated with a time period. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ResultByTime

func (ResultByTime) GoString 

func (s ResultByTime) GoString() string

GoString returns the string representation

func (ResultByTime) String 

func (s ResultByTime) String() string

String returns the string representation

type ServiceSpecification added in v0.4.0 

type ServiceSpecification struct {

	// The EC2 hardware specifications that you want AWS to provide recommendations
	// for.
	EC2Specification *EC2Specification `type:"structure"`
	// contains filtered or unexported fields
}

Hardware specifications for the service that you want recommendations for. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ServiceSpecification

func (ServiceSpecification) GoString added in v0.4.0 

func (s ServiceSpecification) GoString() string

GoString returns the string representation

func (ServiceSpecification) String added in v0.4.0 

func (s ServiceSpecification) String() string

String returns the string representation

type TagValues 

type TagValues struct {

	// The key for a tag.
	Key *string `type:"string"`

	// The specific value of a tag.
	Values []string `type:"list"`
	// contains filtered or unexported fields
}

The values that are available for a tag. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/TagValues

func (TagValues) GoString 

func (s TagValues) GoString() string

GoString returns the string representation

func (TagValues) String 

func (s TagValues) String() string

String returns the string representation

type TermInYears added in v0.4.0 

type TermInYears string
const (
	TermInYearsOneYear    TermInYears = "ONE_YEAR"
	TermInYearsThreeYears TermInYears = "THREE_YEARS"
)

Enum values for TermInYears

func (TermInYears) MarshalValue added in v0.4.0 

func (enum TermInYears) MarshalValue() (string, error)

func (TermInYears) MarshalValueBuf added in v0.4.0 

func (enum TermInYears) MarshalValueBuf(b []byte) ([]byte, error)

type UtilizationByTime 

type UtilizationByTime struct {

	// The groups that are included in this utilization result.
	Groups []ReservationUtilizationGroup `type:"list"`

	// The period of time over which this utilization was used.
	TimePeriod *DateInterval `type:"structure"`

	// The total number of RI hours that were used.
	Total *ReservationAggregates `type:"structure"`
	// contains filtered or unexported fields
}

The amount of utilization, in hours. Please also see https://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/UtilizationByTime

func (UtilizationByTime) GoString 

func (s UtilizationByTime) GoString() string

GoString returns the string representation

func (UtilizationByTime) String 

func (s UtilizationByTime) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package costexploreriface provides an interface to enable mocking the AWS Cost Explorer Service service client for testing your code.
 Package costexploreriface provides an interface to enable mocking the AWS Cost Explorer Service service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.