costandusagereportservice

Documentation

Index

• Constants
• func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
• func NewDefaultEndpointResolver() *internalendpoints.Resolver
• func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
• type Client
  • func New(options Options, optFns ...func(*Options)) *Client
  • func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
  • func (c *Client) DeleteReportDefinition(ctx context.Context, params *DeleteReportDefinitionInput, ...) (*DeleteReportDefinitionOutput, error)
  • func (c *Client) DescribeReportDefinitions(ctx context.Context, params *DescribeReportDefinitionsInput, ...) (*DescribeReportDefinitionsOutput, error)
  • func (c *Client) ModifyReportDefinition(ctx context.Context, params *ModifyReportDefinitionInput, ...) (*ModifyReportDefinitionOutput, error)
  • func (c *Client) PutReportDefinition(ctx context.Context, params *PutReportDefinitionInput, ...) (*PutReportDefinitionOutput, error)
• type DeleteReportDefinitionInput
• type DeleteReportDefinitionOutput
• type DescribeReportDefinitionsInput
• type DescribeReportDefinitionsOutput
• type EndpointResolver
  • func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
• type EndpointResolverFunc
  • func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
• type HTTPClient
• type HTTPSignerV4
• type ModifyReportDefinitionInput
• type ModifyReportDefinitionOutput
• type Options
  • func (o Options) Copy() Options
  • func (o Options) GetCredentials() aws.CredentialsProvider
  • func (o Options) GetEndpointOptions() ResolverOptions
  • func (o Options) GetEndpointResolver() EndpointResolver
  • func (o Options) GetHTTPSignerV4() HTTPSignerV4
  • func (o Options) GetRegion() string
  • func (o Options) GetRetryer() retry.Retryer
• type PutReportDefinitionInput
• type PutReportDefinitionOutput
• type ResolveEndpoint
  • func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, ...) (out middleware.SerializeOutput, metadata middleware.Metadata, err error)
  • func (*ResolveEndpoint) ID() string
• type ResolveEndpointMiddlewareOptions
• type ResolverOptions

Constants

const ServiceAPIVersion = "2017-01-06"

const ServiceID = "Cost and Usage Report Service"

Functions

func AddResolveEndpointMiddleware

func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func RemoveResolveEndpointMiddleware

func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

The AWS Cost and Usage Report API enables you to programmatically create, query, and delete AWS Cost and Usage report definitions. AWS Cost and Usage reports track the monthly AWS costs and usage associated with your AWS account. The report contains line items for each unique combination of AWS product, usage type, and operation that your AWS account uses. You can configure the AWS Cost and Usage report to show only the data that you want, using the AWS Cost and Usage API.</p> <p>Service Endpoint</p> <p>The AWS Cost and Usage Report API provides the following endpoint:</p> <ul> <li> <p>cur.us-east-1.amazonaws.com</p> </li> </ul>

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) DeleteReportDefinition

func (c *Client) DeleteReportDefinition(ctx context.Context, params *DeleteReportDefinitionInput, optFns ...func(*Options)) (*DeleteReportDefinitionOutput, error)

Deletes the specified report.

func (*Client) DescribeReportDefinitions

func (c *Client) DescribeReportDefinitions(ctx context.Context, params *DescribeReportDefinitionsInput, optFns ...func(*Options)) (*DescribeReportDefinitionsOutput, error)

Lists the AWS Cost and Usage reports available to this account.

func (*Client) ModifyReportDefinition

func (c *Client) ModifyReportDefinition(ctx context.Context, params *ModifyReportDefinitionInput, optFns ...func(*Options)) (*ModifyReportDefinitionOutput, error)

Allows you to programatically update your report preferences.

func (*Client) PutReportDefinition

func (c *Client) PutReportDefinition(ctx context.Context, params *PutReportDefinitionInput, optFns ...func(*Options)) (*PutReportDefinitionOutput, error)

Creates a new report using the description that you provide.

type DeleteReportDefinitionInput

type DeleteReportDefinitionInput struct {
	// The name of the report that you want to create. The name must be unique, is case
	// sensitive, and can't include spaces.
	ReportName *string
}

Deletes the specified report.

type DeleteReportDefinitionOutput

type DeleteReportDefinitionOutput struct {
	// Whether the deletion was successful or not.
	ResponseMessage *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

If the action is successful, the service sends back an HTTP 200 response.

type DescribeReportDefinitionsInput

type DescribeReportDefinitionsInput struct {
	// A generic string.
	NextToken *string
	// The maximum number of results that AWS returns for the operation.
	MaxResults *int32
}

Requests a list of AWS Cost and Usage reports owned by the account.

type DescribeReportDefinitionsOutput

type DescribeReportDefinitionsOutput struct {
	// A generic string.
	NextToken *string
	// A list of AWS Cost and Usage reports owned by the account.
	ReportDefinitions []*types.ReportDefinition

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

If the action is successful, the service sends back an HTTP 200 response.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type ModifyReportDefinitionInput

type ModifyReportDefinitionInput struct {
	// The name of the report that you want to create. The name must be unique, is case
	// sensitive, and can't include spaces.
	ReportName *string
	// The definition of AWS Cost and Usage Report. You can specify the report name,
	// time unit, report format, compression format, S3 bucket, additional artifacts,
	// and schema elements in the definition.
	ReportDefinition *types.ReportDefinition
}

type ModifyReportDefinitionOutput

type ModifyReportDefinitionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions ResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetCredentials

func (o Options) GetCredentials() aws.CredentialsProvider

func (Options) GetEndpointOptions

func (o Options) GetEndpointOptions() ResolverOptions

func (Options) GetEndpointResolver

func (o Options) GetEndpointResolver() EndpointResolver

func (Options) GetHTTPSignerV4

func (o Options) GetHTTPSignerV4() HTTPSignerV4

func (Options) GetRegion

func (o Options) GetRegion() string

func (Options) GetRetryer

func (o Options) GetRetryer() retry.Retryer

type PutReportDefinitionInput

type PutReportDefinitionInput struct {
	// Represents the output of the PutReportDefinition operation. The content consists
	// of the detailed metadata and data file information.
	ReportDefinition *types.ReportDefinition
}

Creates a Cost and Usage Report.

type PutReportDefinitionOutput

type PutReportDefinitionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  ResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type ResolveEndpointMiddlewareOptions

type ResolveEndpointMiddlewareOptions interface {
	GetEndpointResolver() EndpointResolver
	GetEndpointOptions() ResolverOptions
}

type ResolverOptions

type ResolverOptions = internalendpoints.Options

ResolverOptions is the service endpoint resolver options