Package software.amazon.awssdk.services.costandusagereport

Interface CostandUsageReportClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface CostandUsageReportClient
extends AutoCloseable

Service client for accessing null. This can be created using the static builder() method. All public APIs for AWS Cost and Usage Report service

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static CostandUsageReportClientBuilder	builder()	Create a builder that can be used to configure and create a CostandUsageReportClient.
static CostandUsageReportClient	create()	Create a CostandUsageReportClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteReportDefinitionResponse	deleteReportDefinition(DeleteReportDefinitionRequest deleteReportDefinitionRequest)	Delete a specified report definition
default DescribeReportDefinitionsResponse	describeReportDefinitions(DescribeReportDefinitionsRequest describeReportDefinitionsRequest)	Describe a list of report definitions owned by the account
default PutReportDefinitionResponse	putReportDefinition(PutReportDefinitionRequest putReportDefinitionRequest)	Create a new report definition
static ServiceMetadata	serviceMetadata()

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static CostandUsageReportClient create()

Create a CostandUsageReportClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CostandUsageReportClientBuilder builder()

Create a builder that can be used to configure and create a CostandUsageReportClient.

deleteReportDefinition

default DeleteReportDefinitionResponse deleteReportDefinition(DeleteReportDefinitionRequest deleteReportDefinitionRequest)
                                                       throws InternalErrorException,
                                                              ValidationException,
                                                              SdkBaseException,
                                                              SdkClientException,
                                                              CostandUsageReportException

Delete a specified report definition

Parameters:

deleteReportDefinitionRequest - Request of DeleteReportDefinition

Returns:

Result of the DeleteReportDefinition operation returned by the service.

Throws:

InternalErrorException - This exception is thrown on a known dependency failure.

ValidationException - This exception is thrown when providing an invalid input. eg. Put a report preference with an invalid report name, or Delete a report preference with an empty report name.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CostandUsageReportException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeReportDefinitions

default DescribeReportDefinitionsResponse describeReportDefinitions(DescribeReportDefinitionsRequest describeReportDefinitionsRequest)
                                                             throws InternalErrorException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    CostandUsageReportException

Describe a list of report definitions owned by the account

Parameters:

describeReportDefinitionsRequest - Request of DescribeReportDefinitions

Returns:

Result of the DescribeReportDefinitions operation returned by the service.

Throws:

InternalErrorException - This exception is thrown on a known dependency failure.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CostandUsageReportException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

putReportDefinition

default PutReportDefinitionResponse putReportDefinition(PutReportDefinitionRequest putReportDefinitionRequest)
                                                 throws DuplicateReportNameException,
                                                        ReportLimitReachedException,
                                                        InternalErrorException,
                                                        ValidationException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        CostandUsageReportException

Create a new report definition

Parameters:

putReportDefinitionRequest - Request of PutReportDefinition

Returns:

Result of the PutReportDefinition operation returned by the service.

Throws:

DuplicateReportNameException - This exception is thrown when putting a report preference with a name that already exists.

ReportLimitReachedException - This exception is thrown when the number of report preference reaches max limit. The max number is 5.

InternalErrorException - This exception is thrown on a known dependency failure.

ValidationException - This exception is thrown when providing an invalid input. eg. Put a report preference with an invalid report name, or Delete a report preference with an empty report name.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CostandUsageReportException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()