Documentation

Overview

    Package costandusagereportservice provides the API client, operations, and parameter types for AWS Cost and Usage Report Service.

    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. Service Endpoint The AWS Cost and Usage Report API provides the following endpoint:

    * cur.us-east-1.amazonaws.com

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2017-01-06"
    View Source
    const ServiceID = "Cost and Usage Report Service"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

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

            Client provides the API client to make operations call for AWS Cost and Usage Report Service.

            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 delete. 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 DescribeReportDefinitionsAPIClient

                            type DescribeReportDefinitionsAPIClient interface {
                            	DescribeReportDefinitions(context.Context, *DescribeReportDefinitionsInput, ...func(*Options)) (*DescribeReportDefinitionsOutput, error)
                            }

                              DescribeReportDefinitionsAPIClient is a client that implements the DescribeReportDefinitions operation.

                              type DescribeReportDefinitionsInput

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

                                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 DescribeReportDefinitionsPaginator

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

                                    DescribeReportDefinitionsPaginator is a paginator for DescribeReportDefinitions

                                    func NewDescribeReportDefinitionsPaginator

                                      NewDescribeReportDefinitionsPaginator returns a new DescribeReportDefinitionsPaginator

                                      func (*DescribeReportDefinitionsPaginator) HasMorePages

                                      func (p *DescribeReportDefinitionsPaginator) HasMorePages() bool

                                        HasMorePages returns a boolean indicating whether more pages are available

                                        func (*DescribeReportDefinitionsPaginator) NextPage

                                          NextPage retrieves the next DescribeReportDefinitions page.

                                          type DescribeReportDefinitionsPaginatorOptions

                                          type DescribeReportDefinitionsPaginatorOptions struct {
                                          	// The maximum number of results that AWS returns for the operation.
                                          	Limit int32
                                          
                                          	// Set to true if pagination should stop if the service returns a pagination token
                                          	// that matches the most recent token provided to the service.
                                          	StopOnDuplicateToken bool
                                          }

                                            DescribeReportDefinitionsPaginatorOptions is the paginator options for DescribeReportDefinitions

                                            type EndpointResolver

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

                                              EndpointResolver interface for resolving service endpoints.

                                              func EndpointResolverFromURL

                                              func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                                EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                                type EndpointResolverFunc

                                                type EndpointResolverFunc func(region string, options EndpointResolverOptions) (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 EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                                  type EndpointResolverOptions

                                                  type EndpointResolverOptions = internalendpoints.Options

                                                    EndpointResolverOptions is the service endpoint resolver options

                                                    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, optFns ...func(*v4.SignerOptions)) error
                                                    }

                                                    type ModifyReportDefinitionInput

                                                    type ModifyReportDefinitionInput struct {
                                                    
                                                    	// 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.
                                                    	//
                                                    	// This member is required.
                                                    	ReportDefinition *types.ReportDefinition
                                                    
                                                    	// The name of the report that you want to create. The name must be unique, is case
                                                    	// sensitive, and can't include spaces.
                                                    	//
                                                    	// This member is required.
                                                    	ReportName *string
                                                    }

                                                    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
                                                    
                                                    	// Configures the events that will be sent to the configured logger.
                                                    	ClientLogMode aws.ClientLogMode
                                                    
                                                    	// The credentials object to use when signing requests.
                                                    	Credentials aws.CredentialsProvider
                                                    
                                                    	// The endpoint options to be used when attempting to resolve an endpoint.
                                                    	EndpointOptions EndpointResolverOptions
                                                    
                                                    	// The service endpoint resolver.
                                                    	EndpointResolver EndpointResolver
                                                    
                                                    	// Signature Version 4 (SigV4) Signer
                                                    	HTTPSignerV4 HTTPSignerV4
                                                    
                                                    	// The logger writer interface to write logging messages to.
                                                    	Logger logging.Logger
                                                    
                                                    	// 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 aws.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.

                                                      type PutReportDefinitionInput

                                                      type PutReportDefinitionInput struct {
                                                      
                                                      	// Represents the output of the PutReportDefinition operation. The content consists
                                                      	// of the detailed metadata and data file information.
                                                      	//
                                                      	// This member is required.
                                                      	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  EndpointResolverOptions
                                                          }

                                                          func (*ResolveEndpoint) HandleSerialize

                                                          func (*ResolveEndpoint) ID

                                                          func (*ResolveEndpoint) ID() string

                                                          Directories

                                                          Path Synopsis
                                                          internal