...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/costexplorer"
Overview
Constants

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 DynamoDB database tables in your production environment.

Service Endpoint

The Cost Explorer API provides the following endpoint:

* https://ce.us-east-1.amazonaws.com

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 contact 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

The stub package, costexploreriface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type CostExplorer
type Coverage
func (s *Coverage) SetCoverageHours(v *CoverageHours) *Coverage
type CoverageByTime
func (s *CoverageByTime) SetGroups(v []*ReservationCoverageGroup) *CoverageByTime
func (s *CoverageByTime) SetTimePeriod(v *DateInterval) *CoverageByTime
func (s *CoverageByTime) SetTotal(v *Coverage) *CoverageByTime
type CoverageHours
func (s *CoverageHours) SetCoverageHoursPercentage(v string) *CoverageHours
func (s *CoverageHours) SetOnDemandHours(v string) *CoverageHours
func (s *CoverageHours) SetReservedHours(v string) *CoverageHours
func (s *CoverageHours) SetTotalRunningHours(v string) *CoverageHours
type DateInterval
func (s *DateInterval) SetEnd(v string) *DateInterval
func (s *DateInterval) SetStart(v string) *DateInterval
type DimensionValues
func (s *DimensionValues) SetKey(v string) *DimensionValues
func (s *DimensionValues) SetValues(v []*string) *DimensionValues
type DimensionValuesWithAttributes
func (s *DimensionValuesWithAttributes) SetAttributes(v map[string]*string) *DimensionValuesWithAttributes
func (s *DimensionValuesWithAttributes) SetValue(v string) *DimensionValuesWithAttributes
type Expression
func (s *Expression) SetAnd(v []*Expression) *Expression
func (s *Expression) SetDimensions(v *DimensionValues) *Expression
func (s *Expression) SetNot(v *Expression) *Expression
func (s *Expression) SetOr(v []*Expression) *Expression
func (s *Expression) SetTags(v *TagValues) *Expression
type GetCostAndUsageInput
func (s *GetCostAndUsageInput) SetFilter(v *Expression) *GetCostAndUsageInput
func (s *GetCostAndUsageInput) SetGranularity(v string) *GetCostAndUsageInput
func (s *GetCostAndUsageInput) SetGroupBy(v []*GroupDefinition) *GetCostAndUsageInput
func (s *GetCostAndUsageInput) SetMetrics(v []*string) *GetCostAndUsageInput
func (s *GetCostAndUsageInput) SetNextPageToken(v string) *GetCostAndUsageInput
func (s *GetCostAndUsageInput) SetTimePeriod(v *DateInterval) *GetCostAndUsageInput
type GetCostAndUsageOutput
func (s *GetCostAndUsageOutput) SetGroupDefinitions(v []*GroupDefinition) *GetCostAndUsageOutput
func (s *GetCostAndUsageOutput) SetNextPageToken(v string) *GetCostAndUsageOutput
func (s *GetCostAndUsageOutput) SetResultsByTime(v []*ResultByTime) *GetCostAndUsageOutput
type GetDimensionValuesInput
func (s *GetDimensionValuesInput) SetContext(v string) *GetDimensionValuesInput
func (s *GetDimensionValuesInput) SetDimension(v string) *GetDimensionValuesInput
func (s *GetDimensionValuesInput) SetNextPageToken(v string) *GetDimensionValuesInput
func (s *GetDimensionValuesInput) SetSearchString(v string) *GetDimensionValuesInput
func (s *GetDimensionValuesInput) SetTimePeriod(v *DateInterval) *GetDimensionValuesInput
type GetDimensionValuesOutput
func (s *GetDimensionValuesOutput) SetDimensionValues(v []*DimensionValuesWithAttributes) *GetDimensionValuesOutput
func (s *GetDimensionValuesOutput) SetNextPageToken(v string) *GetDimensionValuesOutput
func (s *GetDimensionValuesOutput) SetReturnSize(v int64) *GetDimensionValuesOutput
func (s *GetDimensionValuesOutput) SetTotalSize(v int64) *GetDimensionValuesOutput
type GetReservationCoverageInput
func (s *GetReservationCoverageInput) SetFilter(v *Expression) *GetReservationCoverageInput
func (s *GetReservationCoverageInput) SetGranularity(v string) *GetReservationCoverageInput
func (s *GetReservationCoverageInput) SetGroupBy(v []*GroupDefinition) *GetReservationCoverageInput
func (s *GetReservationCoverageInput) SetNextPageToken(v string) *GetReservationCoverageInput
func (s *GetReservationCoverageInput) SetTimePeriod(v *DateInterval) *GetReservationCoverageInput
type GetReservationCoverageOutput
func (s *GetReservationCoverageOutput) SetCoveragesByTime(v []*CoverageByTime) *GetReservationCoverageOutput
func (s *GetReservationCoverageOutput) SetNextPageToken(v string) *GetReservationCoverageOutput
func (s *GetReservationCoverageOutput) SetTotal(v *Coverage) *GetReservationCoverageOutput
type GetReservationUtilizationInput
func (s *GetReservationUtilizationInput) SetFilter(v *Expression) *GetReservationUtilizationInput
func (s *GetReservationUtilizationInput) SetGranularity(v string) *GetReservationUtilizationInput
func (s *GetReservationUtilizationInput) SetGroupBy(v []*GroupDefinition) *GetReservationUtilizationInput
func (s *GetReservationUtilizationInput) SetNextPageToken(v string) *GetReservationUtilizationInput
func (s *GetReservationUtilizationInput) SetTimePeriod(v *DateInterval) *GetReservationUtilizationInput
type GetReservationUtilizationOutput
func (s *GetReservationUtilizationOutput) SetNextPageToken(v string) *GetReservationUtilizationOutput
func (s *GetReservationUtilizationOutput) SetTotal(v *ReservationAggregates) *GetReservationUtilizationOutput
func (s *GetReservationUtilizationOutput) SetUtilizationsByTime(v []*UtilizationByTime) *GetReservationUtilizationOutput
type GetTagsInput
func (s *GetTagsInput) SetNextPageToken(v string) *GetTagsInput
func (s *GetTagsInput) SetSearchString(v string) *GetTagsInput
func (s *GetTagsInput) SetTagKey(v string) *GetTagsInput
func (s *GetTagsInput) SetTimePeriod(v *DateInterval) *GetTagsInput
type GetTagsOutput
func (s *GetTagsOutput) SetNextPageToken(v string) *GetTagsOutput
func (s *GetTagsOutput) SetReturnSize(v int64) *GetTagsOutput
func (s *GetTagsOutput) SetTags(v []*string) *GetTagsOutput
func (s *GetTagsOutput) SetTotalSize(v int64) *GetTagsOutput
type Group
func (s *Group) SetKeys(v []*string) *Group
func (s *Group) SetMetrics(v map[string]*MetricValue) *Group
type GroupDefinition
func (s *GroupDefinition) SetKey(v string) *GroupDefinition
func (s *GroupDefinition) SetType(v string) *GroupDefinition
type MetricValue
func (s *MetricValue) SetAmount(v string) *MetricValue
func (s *MetricValue) SetUnit(v string) *MetricValue
type ReservationAggregates
func (s *ReservationAggregates) SetPurchasedHours(v string) *ReservationAggregates
func (s *ReservationAggregates) SetTotalActualHours(v string) *ReservationAggregates
func (s *ReservationAggregates) SetUnusedHours(v string) *ReservationAggregates
func (s *ReservationAggregates) SetUtilizationPercentage(v string) *ReservationAggregates
type ReservationCoverageGroup
func (s *ReservationCoverageGroup) SetAttributes(v map[string]*string) *ReservationCoverageGroup
func (s *ReservationCoverageGroup) SetCoverage(v *Coverage) *ReservationCoverageGroup
type ReservationUtilizationGroup
func (s *ReservationUtilizationGroup) SetAttributes(v map[string]*string) *ReservationUtilizationGroup
func (s *ReservationUtilizationGroup) SetKey(v string) *ReservationUtilizationGroup
func (s *ReservationUtilizationGroup) SetUtilization(v *ReservationAggregates) *ReservationUtilizationGroup
func (s *ReservationUtilizationGroup) SetValue(v string) *ReservationUtilizationGroup
type ResultByTime
func (s *ResultByTime) SetEstimated(v bool) *ResultByTime
func (s *ResultByTime) SetGroups(v []*Group) *ResultByTime
func (s *ResultByTime) SetTimePeriod(v *DateInterval) *ResultByTime
func (s *ResultByTime) SetTotal(v map[string]*MetricValue) *ResultByTime
type TagValues
func (s *TagValues) SetKey(v string) *TagValues
func (s *TagValues) SetValues(v []*string) *TagValues
type UtilizationByTime
func (s *UtilizationByTime) SetGroups(v []*ReservationUtilizationGroup) *UtilizationByTime
func (s *UtilizationByTime) SetTimePeriod(v *DateInterval) *UtilizationByTime
func (s *UtilizationByTime) SetTotal(v *ReservationAggregates) *UtilizationByTime

Constants ▾

const (
    // ContextCostAndUsage is a Context enum value
    ContextCostAndUsage = "COST_AND_USAGE"

    // ContextReservations is a Context enum value
    ContextReservations = "RESERVATIONS"
)
const (
    // DimensionAz is a Dimension enum value
    DimensionAz = "AZ"

    // DimensionInstanceType is a Dimension enum value
    DimensionInstanceType = "INSTANCE_TYPE"

    // DimensionLinkedAccount is a Dimension enum value
    DimensionLinkedAccount = "LINKED_ACCOUNT"

    // DimensionOperation is a Dimension enum value
    DimensionOperation = "OPERATION"

    // DimensionPurchaseType is a Dimension enum value
    DimensionPurchaseType = "PURCHASE_TYPE"

    // DimensionRegion is a Dimension enum value
    DimensionRegion = "REGION"

    // DimensionService is a Dimension enum value
    DimensionService = "SERVICE"

    // DimensionUsageType is a Dimension enum value
    DimensionUsageType = "USAGE_TYPE"

    // DimensionUsageTypeGroup is a Dimension enum value
    DimensionUsageTypeGroup = "USAGE_TYPE_GROUP"

    // DimensionRecordType is a Dimension enum value
    DimensionRecordType = "RECORD_TYPE"

    // DimensionOperatingSystem is a Dimension enum value
    DimensionOperatingSystem = "OPERATING_SYSTEM"

    // DimensionTenancy is a Dimension enum value
    DimensionTenancy = "TENANCY"

    // DimensionScope is a Dimension enum value
    DimensionScope = "SCOPE"

    // DimensionPlatform is a Dimension enum value
    DimensionPlatform = "PLATFORM"

    // DimensionSubscriptionId is a Dimension enum value
    DimensionSubscriptionId = "SUBSCRIPTION_ID"

    // DimensionLegalEntityName is a Dimension enum value
    DimensionLegalEntityName = "LEGAL_ENTITY_NAME"

    // DimensionDeploymentOption is a Dimension enum value
    DimensionDeploymentOption = "DEPLOYMENT_OPTION"

    // DimensionDatabaseEngine is a Dimension enum value
    DimensionDatabaseEngine = "DATABASE_ENGINE"

    // DimensionCacheEngine is a Dimension enum value
    DimensionCacheEngine = "CACHE_ENGINE"

    // DimensionInstanceTypeFamily is a Dimension enum value
    DimensionInstanceTypeFamily = "INSTANCE_TYPE_FAMILY"
)
const (
    // GranularityDaily is a Granularity enum value
    GranularityDaily = "DAILY"

    // GranularityMonthly is a Granularity enum value
    GranularityMonthly = "MONTHLY"
)
const (
    // GroupDefinitionTypeDimension is a GroupDefinitionType enum value
    GroupDefinitionTypeDimension = "DIMENSION"

    // GroupDefinitionTypeTag is a GroupDefinitionType enum value
    GroupDefinitionTypeTag = "TAG"
)
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"
)
const (
    ServiceName = "ce"        // Service endpoint prefix API calls made to.
    EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

type CostExplorer

type CostExplorer struct {
    *client.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(p client.ConfigProvider, cfgs ...*aws.Config) *CostExplorer

New creates a new instance of the CostExplorer client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a CostExplorer client from just a session.
svc := costexplorer.New(mySession)

// Create a CostExplorer client with additional configuration
svc := costexplorer.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CostExplorer) GetCostAndUsage

func (c *CostExplorer) GetCostAndUsage(input *GetCostAndUsageInput) (*GetCostAndUsageOutput, error)

GetCostAndUsage API operation for AWS Cost Explorer Service.

Retrieve 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. See the GetDimensionValues action for a complete list of the valid dimensions. Master accounts in an organization have access to all member accounts.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cost Explorer Service's API operation GetCostAndUsage for usage and error information.

Returned Error Codes:

* ErrCodeLimitExceededException "LimitExceededException"
You made too many calls in a short period of time. Try again later.

* ErrCodeBillExpirationException "BillExpirationException"
The requested report expired. Update the date interval and try again.

* ErrCodeDataUnavailableException "DataUnavailableException"
The requested data is unavailable.

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
The pagination token is invalid. Try again without a pagination token.

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

func (*CostExplorer) GetCostAndUsageRequest

func (c *CostExplorer) GetCostAndUsageRequest(input *GetCostAndUsageInput) (req *request.Request, output *GetCostAndUsageOutput)

GetCostAndUsageRequest generates a "aws/request.Request" representing the client's request for the GetCostAndUsage operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCostAndUsage for more information on using the GetCostAndUsage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetCostAndUsageRequest method.
req, resp := client.GetCostAndUsageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CostExplorer) GetCostAndUsageWithContext

func (c *CostExplorer) GetCostAndUsageWithContext(ctx aws.Context, input *GetCostAndUsageInput, opts ...request.Option) (*GetCostAndUsageOutput, error)

GetCostAndUsageWithContext is the same as GetCostAndUsage with the addition of the ability to pass a context and additional request options.

See GetCostAndUsage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CostExplorer) GetDimensionValues

func (c *CostExplorer) GetDimensionValues(input *GetDimensionValuesInput) (*GetDimensionValuesOutput, error)

GetDimensionValues API operation for AWS Cost Explorer Service.

You can use GetDimensionValues to retrieve all available filter values for a specific filter over a period of time. You can search the dimension values for an arbitrary string.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cost Explorer Service's API operation GetDimensionValues for usage and error information.

Returned Error Codes:

* ErrCodeLimitExceededException "LimitExceededException"
You made too many calls in a short period of time. Try again later.

* ErrCodeBillExpirationException "BillExpirationException"
The requested report expired. Update the date interval and try again.

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
The pagination token is invalid. Try again without a pagination token.

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

func (*CostExplorer) GetDimensionValuesRequest

func (c *CostExplorer) GetDimensionValuesRequest(input *GetDimensionValuesInput) (req *request.Request, output *GetDimensionValuesOutput)

GetDimensionValuesRequest generates a "aws/request.Request" representing the client's request for the GetDimensionValues operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDimensionValues for more information on using the GetDimensionValues API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDimensionValuesRequest method.
req, resp := client.GetDimensionValuesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CostExplorer) GetDimensionValuesWithContext

func (c *CostExplorer) GetDimensionValuesWithContext(ctx aws.Context, input *GetDimensionValuesInput, opts ...request.Option) (*GetDimensionValuesOutput, error)

GetDimensionValuesWithContext is the same as GetDimensionValues with the addition of the ability to pass a context and additional request options.

See GetDimensionValues for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CostExplorer) GetReservationCoverage

func (c *CostExplorer) GetReservationCoverage(input *GetReservationCoverageInput) (*GetReservationCoverageOutput, error)

GetReservationCoverage API operation for AWS Cost Explorer Service.

Retrieve the reservation coverage for your account. An organization's master account has access to the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions.

* AZ

* INSTANCE_TYPE

* LINKED_ACCOUNT

* PLATFORM

* REGION

* TENANCY

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cost Explorer Service's API operation GetReservationCoverage for usage and error information.

Returned Error Codes:

* ErrCodeLimitExceededException "LimitExceededException"
You made too many calls in a short period of time. Try again later.

* ErrCodeDataUnavailableException "DataUnavailableException"
The requested data is unavailable.

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
The pagination token is invalid. Try again without a pagination token.

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

func (*CostExplorer) GetReservationCoverageRequest

func (c *CostExplorer) GetReservationCoverageRequest(input *GetReservationCoverageInput) (req *request.Request, output *GetReservationCoverageOutput)

GetReservationCoverageRequest generates a "aws/request.Request" representing the client's request for the GetReservationCoverage operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetReservationCoverage for more information on using the GetReservationCoverage API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetReservationCoverageRequest method.
req, resp := client.GetReservationCoverageRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CostExplorer) GetReservationCoverageWithContext

func (c *CostExplorer) GetReservationCoverageWithContext(ctx aws.Context, input *GetReservationCoverageInput, opts ...request.Option) (*GetReservationCoverageOutput, error)

GetReservationCoverageWithContext is the same as GetReservationCoverage with the addition of the ability to pass a context and additional request options.

See GetReservationCoverage for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CostExplorer) GetReservationUtilization

func (c *CostExplorer) GetReservationUtilization(input *GetReservationUtilizationInput) (*GetReservationUtilizationOutput, error)

GetReservationUtilization API operation for AWS Cost Explorer Service.

You can retrieve the Reservation utilization for your account. Master accounts in an organization have access to their associated 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cost Explorer Service's API operation GetReservationUtilization for usage and error information.

Returned Error Codes:

* ErrCodeLimitExceededException "LimitExceededException"
You made too many calls in a short period of time. Try again later.

* ErrCodeDataUnavailableException "DataUnavailableException"
The requested data is unavailable.

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
The pagination token is invalid. Try again without a pagination token.

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

func (*CostExplorer) GetReservationUtilizationRequest

func (c *CostExplorer) GetReservationUtilizationRequest(input *GetReservationUtilizationInput) (req *request.Request, output *GetReservationUtilizationOutput)

GetReservationUtilizationRequest generates a "aws/request.Request" representing the client's request for the GetReservationUtilization operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetReservationUtilization for more information on using the GetReservationUtilization API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetReservationUtilizationRequest method.
req, resp := client.GetReservationUtilizationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CostExplorer) GetReservationUtilizationWithContext

func (c *CostExplorer) GetReservationUtilizationWithContext(ctx aws.Context, input *GetReservationUtilizationInput, opts ...request.Option) (*GetReservationUtilizationOutput, error)

GetReservationUtilizationWithContext is the same as GetReservationUtilization with the addition of the ability to pass a context and additional request options.

See GetReservationUtilization for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CostExplorer) GetTags

func (c *CostExplorer) GetTags(input *GetTagsInput) (*GetTagsOutput, error)

GetTags API operation for AWS Cost Explorer Service.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cost Explorer Service's API operation GetTags for usage and error information.

Returned Error Codes:

* ErrCodeLimitExceededException "LimitExceededException"
You made too many calls in a short period of time. Try again later.

* ErrCodeBillExpirationException "BillExpirationException"
The requested report expired. Update the date interval and try again.

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
The pagination token is invalid. Try again without a pagination token.

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

func (*CostExplorer) GetTagsRequest

func (c *CostExplorer) GetTagsRequest(input *GetTagsInput) (req *request.Request, output *GetTagsOutput)

GetTagsRequest generates a "aws/request.Request" representing the client's request for the GetTags operation. The "output" return value will be populated with the request's response once the request complets successfuly.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTags for more information on using the GetTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetTagsRequest method.
req, resp := client.GetTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CostExplorer) GetTagsWithContext

func (c *CostExplorer) GetTagsWithContext(ctx aws.Context, input *GetTagsInput, opts ...request.Option) (*GetTagsOutput, error)

GetTagsWithContext is the same as GetTags with the addition of the ability to pass a context and additional request options.

See GetTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Coverage

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.

func (Coverage) GoString

func (s Coverage) GoString() string

GoString returns the string representation

func (*Coverage) SetCoverageHours

func (s *Coverage) SetCoverageHours(v *CoverageHours) *Coverage

SetCoverageHours sets the CoverageHours field's value.

func (Coverage) String

func (s Coverage) String() string

String returns the string representation

type CoverageByTime

type CoverageByTime struct {

    // The group of instances that a reservation covered.
    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, in hours.

func (CoverageByTime) GoString

func (s CoverageByTime) GoString() string

GoString returns the string representation

func (*CoverageByTime) SetGroups

func (s *CoverageByTime) SetGroups(v []*ReservationCoverageGroup) *CoverageByTime

SetGroups sets the Groups field's value.

func (*CoverageByTime) SetTimePeriod

func (s *CoverageByTime) SetTimePeriod(v *DateInterval) *CoverageByTime

SetTimePeriod sets the TimePeriod field's value.

func (*CoverageByTime) SetTotal

func (s *CoverageByTime) SetTotal(v *Coverage) *CoverageByTime

SetTotal sets the Total field's value.

func (CoverageByTime) String

func (s CoverageByTime) String() string

String returns the string representation

type CoverageHours

type CoverageHours struct {

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

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

    // The number of instance running hours 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.

func (CoverageHours) GoString

func (s CoverageHours) GoString() string

GoString returns the string representation

func (*CoverageHours) SetCoverageHoursPercentage

func (s *CoverageHours) SetCoverageHoursPercentage(v string) *CoverageHours

SetCoverageHoursPercentage sets the CoverageHoursPercentage field's value.

func (*CoverageHours) SetOnDemandHours

func (s *CoverageHours) SetOnDemandHours(v string) *CoverageHours

SetOnDemandHours sets the OnDemandHours field's value.

func (*CoverageHours) SetReservedHours

func (s *CoverageHours) SetReservedHours(v string) *CoverageHours

SetReservedHours sets the ReservedHours field's value.

func (*CoverageHours) SetTotalRunningHours

func (s *CoverageHours) SetTotalRunningHours(v string) *CoverageHours

SetTotalRunningHours sets the TotalRunningHours field's value.

func (CoverageHours) String

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 the end is 2017-05-01, then the cost and
    // usage data is retrieved from the start date 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, then the cost
    // and usage data is retrieved 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.

func (DateInterval) GoString

func (s DateInterval) GoString() string

GoString returns the string representation

func (*DateInterval) SetEnd

func (s *DateInterval) SetEnd(v string) *DateInterval

SetEnd sets the End field's value.

func (*DateInterval) SetStart

func (s *DateInterval) SetStart(v string) *DateInterval

SetStart sets the Start field's value.

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 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 *string `type:"string" enum:"Dimension"`

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

func (DimensionValues) GoString

func (s DimensionValues) GoString() string

GoString returns the string representation

func (*DimensionValues) SetKey

func (s *DimensionValues) SetKey(v string) *DimensionValues

SetKey sets the Key field's value.

func (*DimensionValues) SetValues

func (s *DimensionValues) SetValues(v []*string) *DimensionValues

SetValues sets the Values field's value.

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.

func (DimensionValuesWithAttributes) GoString

func (s DimensionValuesWithAttributes) GoString() string

GoString returns the string representation

func (*DimensionValuesWithAttributes) SetAttributes

func (s *DimensionValuesWithAttributes) SetAttributes(v map[string]*string) *DimensionValuesWithAttributes

SetAttributes sets the Attributes field's value.

func (*DimensionValuesWithAttributes) SetValue

func (s *DimensionValuesWithAttributes) SetValue(v string) *DimensionValuesWithAttributes

SetValue sets the Value field's value.

func (DimensionValuesWithAttributes) String

func (s DimensionValuesWithAttributes) 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 Dimension.
    Not *Expression `type:"structure"`

    // Return results that match either Dimension.
    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 will create an error.

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

func (Expression) GoString

func (s Expression) GoString() string

GoString returns the string representation

func (*Expression) SetAnd

func (s *Expression) SetAnd(v []*Expression) *Expression

SetAnd sets the And field's value.

func (*Expression) SetDimensions

func (s *Expression) SetDimensions(v *DimensionValues) *Expression

SetDimensions sets the Dimensions field's value.

func (*Expression) SetNot

func (s *Expression) SetNot(v *Expression) *Expression

SetNot sets the Not field's value.

func (*Expression) SetOr

func (s *Expression) SetOr(v []*Expression) *Expression

SetOr sets the Or field's value.

func (*Expression) SetTags

func (s *Expression) SetTags(v *TagValues) *Expression

SetTags sets the Tags field's value.

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 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 *string `type:"string" enum:"Granularity"`

    // 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, 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 []*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
}

func (GetCostAndUsageInput) GoString

func (s GetCostAndUsageInput) GoString() string

GoString returns the string representation

func (*GetCostAndUsageInput) SetFilter

func (s *GetCostAndUsageInput) SetFilter(v *Expression) *GetCostAndUsageInput

SetFilter sets the Filter field's value.

func (*GetCostAndUsageInput) SetGranularity

func (s *GetCostAndUsageInput) SetGranularity(v string) *GetCostAndUsageInput

SetGranularity sets the Granularity field's value.

func (*GetCostAndUsageInput) SetGroupBy

func (s *GetCostAndUsageInput) SetGroupBy(v []*GroupDefinition) *GetCostAndUsageInput

SetGroupBy sets the GroupBy field's value.

func (*GetCostAndUsageInput) SetMetrics

func (s *GetCostAndUsageInput) SetMetrics(v []*string) *GetCostAndUsageInput

SetMetrics sets the Metrics field's value.

func (*GetCostAndUsageInput) SetNextPageToken

func (s *GetCostAndUsageInput) SetNextPageToken(v string) *GetCostAndUsageInput

SetNextPageToken sets the NextPageToken field's value.

func (*GetCostAndUsageInput) SetTimePeriod

func (s *GetCostAndUsageInput) SetTimePeriod(v *DateInterval) *GetCostAndUsageInput

SetTimePeriod sets the TimePeriod field's value.

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 specified by the 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 covered by the results in the response.
    ResultsByTime []*ResultByTime `type:"list"`
    // contains filtered or unexported fields
}

func (GetCostAndUsageOutput) GoString

func (s GetCostAndUsageOutput) GoString() string

GoString returns the string representation

func (*GetCostAndUsageOutput) SetGroupDefinitions

func (s *GetCostAndUsageOutput) SetGroupDefinitions(v []*GroupDefinition) *GetCostAndUsageOutput

SetGroupDefinitions sets the GroupDefinitions field's value.

func (*GetCostAndUsageOutput) SetNextPageToken

func (s *GetCostAndUsageOutput) SetNextPageToken(v string) *GetCostAndUsageOutput

SetNextPageToken sets the NextPageToken field's value.

func (*GetCostAndUsageOutput) SetResultsByTime

func (s *GetCostAndUsageOutput) SetResultsByTime(v []*ResultByTime) *GetCostAndUsageOutput

SetResultsByTime sets the ResultsByTime field's value.

func (GetCostAndUsageOutput) String

func (s GetCostAndUsageOutput) String() string

String returns the string representation

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
    // action. 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 CostAndUsage, you can use the following dimensions
    // for searching:
    //
    //    * AZ - The Availability Zone. An example is us-east-1a.
    //
    //    * 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
    //
    //    * OPERATION - The action performed. Examples include RunInstance and CreateBucket.
    //
    //    * 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 DynamoDB.
    //
    //    * USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes.
    //    The response for the GetDimensionValues action includes a unit attribute,
    //    examples of which include GB and Hrs.
    //
    //    * USAGE_TYPE_GROUP - The grouping of common usage types. An example is
    //    EC2: CloudWatch – Alarms. The response for this action 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.
    //
    //    * 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 operating system. Examples are Windows or Linux.
    //
    //    * REGION - The AWS region.
    //
    //    * SCOPE - The scope of a reserved instance (RI). Values are regional or
    //    a single availability zone.
    //
    //    * TENANCY - The tenancy of a resource. Examples are shared or dedicated.
    Context *string `type:"string" enum:"Context"`

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

    // 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
}

func (GetDimensionValuesInput) GoString

func (s GetDimensionValuesInput) GoString() string

GoString returns the string representation

func (*GetDimensionValuesInput) SetContext

func (s *GetDimensionValuesInput) SetContext(v string) *GetDimensionValuesInput

SetContext sets the Context field's value.

func (*GetDimensionValuesInput) SetDimension

func (s *GetDimensionValuesInput) SetDimension(v string) *GetDimensionValuesInput

SetDimension sets the Dimension field's value.

func (*GetDimensionValuesInput) SetNextPageToken

func (s *GetDimensionValuesInput) SetNextPageToken(v string) *GetDimensionValuesInput

SetNextPageToken sets the NextPageToken field's value.

func (*GetDimensionValuesInput) SetSearchString

func (s *GetDimensionValuesInput) SetSearchString(v string) *GetDimensionValuesInput

SetSearchString sets the SearchString field's value.

func (*GetDimensionValuesInput) SetTimePeriod

func (s *GetDimensionValuesInput) SetTimePeriod(v *DateInterval) *GetDimensionValuesInput

SetTimePeriod sets the TimePeriod field's value.

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 CostAndUsage, you can use the following dimensions
    // for searching:
    //
    //    * AZ - The Availability Zone. An example is us-east-1a.
    //
    //    * 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
    //
    //    * OPERATION - The action performed. Examples include RunInstance and CreateBucket.
    //
    //    * 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 DynamoDB.
    //
    //    * USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes.
    //    The response for the GetDimensionValues action includes a unit attribute,
    //    examples of which include GB and Hrs.
    //
    //    * USAGE_TYPE_GROUP - The grouping of common usage types. An example is
    //    EC2: CloudWatch – Alarms. The response for this action 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.
    //
    //    * 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 operating system. Examples are Windows or Linux.
    //
    //    * REGION - The AWS region.
    //
    //    * SCOPE - The scope of a reserved instance (RI). Values are regional or
    //    a single availability zone.
    //
    //    * 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
}

func (GetDimensionValuesOutput) GoString

func (s GetDimensionValuesOutput) GoString() string

GoString returns the string representation

func (*GetDimensionValuesOutput) SetDimensionValues

func (s *GetDimensionValuesOutput) SetDimensionValues(v []*DimensionValuesWithAttributes) *GetDimensionValuesOutput

SetDimensionValues sets the DimensionValues field's value.

func (*GetDimensionValuesOutput) SetNextPageToken

func (s *GetDimensionValuesOutput) SetNextPageToken(v string) *GetDimensionValuesOutput

SetNextPageToken sets the NextPageToken field's value.

func (*GetDimensionValuesOutput) SetReturnSize

func (s *GetDimensionValuesOutput) SetReturnSize(v int64) *GetDimensionValuesOutput

SetReturnSize sets the ReturnSize field's value.

func (*GetDimensionValuesOutput) SetTotalSize

func (s *GetDimensionValuesOutput) SetTotalSize(v int64) *GetDimensionValuesOutput

SetTotalSize sets the TotalSize field's value.

func (GetDimensionValuesOutput) String

func (s GetDimensionValuesOutput) String() string

String returns the string representation

type GetReservationCoverageInput

type GetReservationCoverageInput struct {

    // Filters utilization data by dimensions. You can filter by the following dimensions.
    //
    //    * AZ
    //
    //    * INSTANCE_TYPE
    //
    //    * LINKED_ACCOUNT
    //
    //    * PLATFORM
    //
    //    * REGION
    //
    //    * TENANCY
    //
    // GetReservationCoverage uses the same Expression 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 the Granularity, either MONTHLY or DAILY.
    Granularity *string `type:"string" enum:"Granularity"`

    // You can group the data by the following attributes.
    //
    //    * AZ
    //
    //    * INSTANCE_TYPE
    //
    //    * LINKED_ACCOUNT
    //
    //    * PLATFORM
    //
    //    * REGION
    //
    //    * 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 query for how much of your instance usage was covered by a reservation.

func (GetReservationCoverageInput) GoString

func (s GetReservationCoverageInput) GoString() string

GoString returns the string representation

func (*GetReservationCoverageInput) SetFilter

func (s *GetReservationCoverageInput) SetFilter(v *Expression) *GetReservationCoverageInput

SetFilter sets the Filter field's value.

func (*GetReservationCoverageInput) SetGranularity

func (s *GetReservationCoverageInput) SetGranularity(v string) *GetReservationCoverageInput

SetGranularity sets the Granularity field's value.

func (*GetReservationCoverageInput) SetGroupBy

func (s *GetReservationCoverageInput) SetGroupBy(v []*GroupDefinition) *GetReservationCoverageInput

SetGroupBy sets the GroupBy field's value.

func (*GetReservationCoverageInput) SetNextPageToken

func (s *GetReservationCoverageInput) SetNextPageToken(v string) *GetReservationCoverageInput

SetNextPageToken sets the NextPageToken field's value.

func (*GetReservationCoverageInput) SetTimePeriod

func (s *GetReservationCoverageInput) SetTimePeriod(v *DateInterval) *GetReservationCoverageInput

SetTimePeriod sets the TimePeriod field's value.

func (GetReservationCoverageInput) String

func (s GetReservationCoverageInput) String() string

String returns the string representation

func (*GetReservationCoverageInput) Validate

func (s *GetReservationCoverageInput) Validate() error

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

type GetReservationCoverageOutput

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 covered by a reservation.
    Total *Coverage `type:"structure"`
    // contains filtered or unexported fields
}

func (GetReservationCoverageOutput) GoString

func (s GetReservationCoverageOutput) GoString() string

GoString returns the string representation

func (*GetReservationCoverageOutput) SetCoveragesByTime

func (s *GetReservationCoverageOutput) SetCoveragesByTime(v []*CoverageByTime) *GetReservationCoverageOutput

SetCoveragesByTime sets the CoveragesByTime field's value.

func (*GetReservationCoverageOutput) SetNextPageToken

func (s *GetReservationCoverageOutput) SetNextPageToken(v string) *GetReservationCoverageOutput

SetNextPageToken sets the NextPageToken field's value.

func (*GetReservationCoverageOutput) SetTotal

func (s *GetReservationCoverageOutput) SetTotal(v *Coverage) *GetReservationCoverageOutput

SetTotal sets the Total field's value.

func (GetReservationCoverageOutput) String

func (s GetReservationCoverageOutput) String() string

String returns the string representation

type GetReservationUtilizationInput

type GetReservationUtilizationInput struct {

    // Filters utilization data by using different dimensions. GetReservationUtilization
    // uses the same Expression 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 the Granularity, either MONTHLY or DAILY.
    // If both GroupBy and Granularity aren't set, GetReservationUtilization defaults
    // to DAILY.
    Granularity *string `type:"string" enum:"Granularity"`

    // 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 reserve 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
}

func (GetReservationUtilizationInput) GoString

func (s GetReservationUtilizationInput) GoString() string

GoString returns the string representation

func (*GetReservationUtilizationInput) SetFilter

func (s *GetReservationUtilizationInput) SetFilter(v *Expression) *GetReservationUtilizationInput

SetFilter sets the Filter field's value.

func (*GetReservationUtilizationInput) SetGranularity

func (s *GetReservationUtilizationInput) SetGranularity(v string) *GetReservationUtilizationInput

SetGranularity sets the Granularity field's value.

func (*GetReservationUtilizationInput) SetGroupBy

func (s *GetReservationUtilizationInput) SetGroupBy(v []*GroupDefinition) *GetReservationUtilizationInput

SetGroupBy sets the GroupBy field's value.

func (*GetReservationUtilizationInput) SetNextPageToken

func (s *GetReservationUtilizationInput) SetNextPageToken(v string) *GetReservationUtilizationInput

SetNextPageToken sets the NextPageToken field's value.

func (*GetReservationUtilizationInput) SetTimePeriod

func (s *GetReservationUtilizationInput) SetTimePeriod(v *DateInterval) *GetReservationUtilizationInput

SetTimePeriod sets the TimePeriod field's value.

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
}

func (GetReservationUtilizationOutput) GoString

func (s GetReservationUtilizationOutput) GoString() string

GoString returns the string representation

func (*GetReservationUtilizationOutput) SetNextPageToken

func (s *GetReservationUtilizationOutput) SetNextPageToken(v string) *GetReservationUtilizationOutput

SetNextPageToken sets the NextPageToken field's value.

func (*GetReservationUtilizationOutput) SetTotal

func (s *GetReservationUtilizationOutput) SetTotal(v *ReservationAggregates) *GetReservationUtilizationOutput

SetTotal sets the Total field's value.

func (*GetReservationUtilizationOutput) SetUtilizationsByTime

func (s *GetReservationUtilizationOutput) SetUtilizationsByTime(v []*UtilizationByTime) *GetReservationUtilizationOutput

SetUtilizationsByTime sets the UtilizationsByTime field's value.

func (GetReservationUtilizationOutput) String

func (s GetReservationUtilizationOutput) String() string

String returns the string representation

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
}

func (GetTagsInput) GoString

func (s GetTagsInput) GoString() string

GoString returns the string representation

func (*GetTagsInput) SetNextPageToken

func (s *GetTagsInput) SetNextPageToken(v string) *GetTagsInput

SetNextPageToken sets the NextPageToken field's value.

func (*GetTagsInput) SetSearchString

func (s *GetTagsInput) SetSearchString(v string) *GetTagsInput

SetSearchString sets the SearchString field's value.

func (*GetTagsInput) SetTagKey

func (s *GetTagsInput) SetTagKey(v string) *GetTagsInput

SetTagKey sets the TagKey field's value.

func (*GetTagsInput) SetTimePeriod

func (s *GetTagsInput) SetTimePeriod(v *DateInterval) *GetTagsInput

SetTimePeriod sets the TimePeriod field's value.

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
}

func (GetTagsOutput) GoString

func (s GetTagsOutput) GoString() string

GoString returns the string representation

func (*GetTagsOutput) SetNextPageToken

func (s *GetTagsOutput) SetNextPageToken(v string) *GetTagsOutput

SetNextPageToken sets the NextPageToken field's value.

func (*GetTagsOutput) SetReturnSize

func (s *GetTagsOutput) SetReturnSize(v int64) *GetTagsOutput

SetReturnSize sets the ReturnSize field's value.

func (*GetTagsOutput) SetTags

func (s *GetTagsOutput) SetTags(v []*string) *GetTagsOutput

SetTags sets the Tags field's value.

func (*GetTagsOutput) SetTotalSize

func (s *GetTagsOutput) SetTotalSize(v int64) *GetTagsOutput

SetTotalSize sets the TotalSize field's value.

func (GetTagsOutput) String

func (s GetTagsOutput) String() string

String returns the string representation

type Group

type Group struct {

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

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

One level of grouped data within the results.

func (Group) GoString

func (s Group) GoString() string

GoString returns the string representation

func (*Group) SetKeys

func (s *Group) SetKeys(v []*string) *Group

SetKeys sets the Keys field's value.

func (*Group) SetMetrics

func (s *Group) SetMetrics(v map[string]*MetricValue) *Group

SetMetrics sets the Metrics field's value.

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 *string `type:"string" enum:"GroupDefinitionType"`
    // 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.

func (GroupDefinition) GoString

func (s GroupDefinition) GoString() string

GoString returns the string representation

func (*GroupDefinition) SetKey

func (s *GroupDefinition) SetKey(v string) *GroupDefinition

SetKey sets the Key field's value.

func (*GroupDefinition) SetType

func (s *GroupDefinition) SetType(v string) *GroupDefinition

SetType sets the Type field's value.

func (GroupDefinition) String

func (s GroupDefinition) String() string

String returns the string representation

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.

func (MetricValue) GoString

func (s MetricValue) GoString() string

GoString returns the string representation

func (*MetricValue) SetAmount

func (s *MetricValue) SetAmount(v string) *MetricValue

SetAmount sets the Amount field's value.

func (*MetricValue) SetUnit

func (s *MetricValue) SetUnit(v string) *MetricValue

SetUnit sets the Unit field's value.

func (MetricValue) String

func (s MetricValue) String() string

String returns the string representation

type ReservationAggregates

type ReservationAggregates struct {

    // How many RI hours 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.

func (ReservationAggregates) GoString

func (s ReservationAggregates) GoString() string

GoString returns the string representation

func (*ReservationAggregates) SetPurchasedHours

func (s *ReservationAggregates) SetPurchasedHours(v string) *ReservationAggregates

SetPurchasedHours sets the PurchasedHours field's value.

func (*ReservationAggregates) SetTotalActualHours

func (s *ReservationAggregates) SetTotalActualHours(v string) *ReservationAggregates

SetTotalActualHours sets the TotalActualHours field's value.

func (*ReservationAggregates) SetUnusedHours

func (s *ReservationAggregates) SetUnusedHours(v string) *ReservationAggregates

SetUnusedHours sets the UnusedHours field's value.

func (*ReservationAggregates) SetUtilizationPercentage

func (s *ReservationAggregates) SetUtilizationPercentage(v string) *ReservationAggregates

SetUtilizationPercentage sets the UtilizationPercentage field's value.

func (ReservationAggregates) String

func (s ReservationAggregates) String() string

String returns the string representation

type ReservationCoverageGroup

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.

func (ReservationCoverageGroup) GoString

func (s ReservationCoverageGroup) GoString() string

GoString returns the string representation

func (*ReservationCoverageGroup) SetAttributes

func (s *ReservationCoverageGroup) SetAttributes(v map[string]*string) *ReservationCoverageGroup

SetAttributes sets the Attributes field's value.

func (*ReservationCoverageGroup) SetCoverage

func (s *ReservationCoverageGroup) SetCoverage(v *Coverage) *ReservationCoverageGroup

SetCoverage sets the Coverage field's value.

func (ReservationCoverageGroup) String

func (s ReservationCoverageGroup) 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.

func (ReservationUtilizationGroup) GoString

func (s ReservationUtilizationGroup) GoString() string

GoString returns the string representation

func (*ReservationUtilizationGroup) SetAttributes

func (s *ReservationUtilizationGroup) SetAttributes(v map[string]*string) *ReservationUtilizationGroup

SetAttributes sets the Attributes field's value.

func (*ReservationUtilizationGroup) SetKey

func (s *ReservationUtilizationGroup) SetKey(v string) *ReservationUtilizationGroup

SetKey sets the Key field's value.

func (*ReservationUtilizationGroup) SetUtilization

func (s *ReservationUtilizationGroup) SetUtilization(v *ReservationAggregates) *ReservationUtilizationGroup

SetUtilization sets the Utilization field's value.

func (*ReservationUtilizationGroup) SetValue

func (s *ReservationUtilizationGroup) SetValue(v string) *ReservationUtilizationGroup

SetValue sets the Value field's value.

func (ReservationUtilizationGroup) String

func (s ReservationUtilizationGroup) String() string

String returns the string representation

type ResultByTime

type ResultByTime struct {

    // Whether or not 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.

func (ResultByTime) GoString

func (s ResultByTime) GoString() string

GoString returns the string representation

func (*ResultByTime) SetEstimated

func (s *ResultByTime) SetEstimated(v bool) *ResultByTime

SetEstimated sets the Estimated field's value.

func (*ResultByTime) SetGroups

func (s *ResultByTime) SetGroups(v []*Group) *ResultByTime

SetGroups sets the Groups field's value.

func (*ResultByTime) SetTimePeriod

func (s *ResultByTime) SetTimePeriod(v *DateInterval) *ResultByTime

SetTimePeriod sets the TimePeriod field's value.

func (*ResultByTime) SetTotal

func (s *ResultByTime) SetTotal(v map[string]*MetricValue) *ResultByTime

SetTotal sets the Total field's value.

func (ResultByTime) String

func (s ResultByTime) 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.

func (TagValues) GoString

func (s TagValues) GoString() string

GoString returns the string representation

func (*TagValues) SetKey

func (s *TagValues) SetKey(v string) *TagValues

SetKey sets the Key field's value.

func (*TagValues) SetValues

func (s *TagValues) SetValues(v []*string) *TagValues

SetValues sets the Values field's value.

func (TagValues) String

func (s TagValues) String() string

String returns the string representation

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.

func (UtilizationByTime) GoString

func (s UtilizationByTime) GoString() string

GoString returns the string representation

func (*UtilizationByTime) SetGroups

func (s *UtilizationByTime) SetGroups(v []*ReservationUtilizationGroup) *UtilizationByTime

SetGroups sets the Groups field's value.

func (*UtilizationByTime) SetTimePeriod

func (s *UtilizationByTime) SetTimePeriod(v *DateInterval) *UtilizationByTime

SetTimePeriod sets the TimePeriod field's value.

func (*UtilizationByTime) SetTotal

func (s *UtilizationByTime) SetTotal(v *ReservationAggregates) *UtilizationByTime

SetTotal sets the Total field's value.

func (UtilizationByTime) String

func (s UtilizationByTime) String() string

String returns the string representation