com.amazonaws.services.applicationcostprofiler.AWSApplicationCostProfiler Maven / Gradle / Ivy
Show all versions of aws-java-sdk-applicationcostprofiler Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.applicationcostprofiler;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.applicationcostprofiler.model.*;
/**
* Interface for accessing AWS Application Cost Profiler.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.applicationcostprofiler.AbstractAWSApplicationCostProfiler} instead.
*
*
*
* This reference provides descriptions of the AWS Application Cost Profiler API.
*
*
* The AWS Application Cost Profiler API provides programmatic access to view, create, update, and delete application
* cost report definitions, as well as to import your usage data into the Application Cost Profiler service.
*
*
* For more information about using this service, see the AWS Application Cost
* Profiler User Guide.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSApplicationCostProfiler {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "application-cost-profiler";
/**
*
* Deletes the specified report definition in AWS Application Cost Profiler. This stops the report from being
* generated.
*
*
* @param deleteReportDefinitionRequest
* @return Result of the DeleteReportDefinition operation returned by the service.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @throws ThrottlingException
* The calls to AWS Application Cost Profiler API are throttled. The request was denied.
* @throws ValidationException
* The input fails to satisfy the constraints for the API.
* @throws AccessDeniedException
* You do not have permission to perform this action.
* @sample AWSApplicationCostProfiler.DeleteReportDefinition
* @see AWS API Documentation
*/
DeleteReportDefinitionResult deleteReportDefinition(DeleteReportDefinitionRequest deleteReportDefinitionRequest);
/**
*
* Retrieves the definition of a report already configured in AWS Application Cost Profiler.
*
*
* @param getReportDefinitionRequest
* @return Result of the GetReportDefinition operation returned by the service.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @throws ThrottlingException
* The calls to AWS Application Cost Profiler API are throttled. The request was denied.
* @throws ValidationException
* The input fails to satisfy the constraints for the API.
* @throws AccessDeniedException
* You do not have permission to perform this action.
* @sample AWSApplicationCostProfiler.GetReportDefinition
* @see AWS API Documentation
*/
GetReportDefinitionResult getReportDefinition(GetReportDefinitionRequest getReportDefinitionRequest);
/**
*
* Ingests application usage data from Amazon Simple Storage Service (Amazon S3).
*
*
* The data must already exist in the S3 location. As part of the action, AWS Application Cost Profiler copies the
* object from your S3 bucket to an S3 bucket owned by Amazon for processing asynchronously.
*
*
* @param importApplicationUsageRequest
* @return Result of the ImportApplicationUsage operation returned by the service.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @throws ThrottlingException
* The calls to AWS Application Cost Profiler API are throttled. The request was denied.
* @throws ValidationException
* The input fails to satisfy the constraints for the API.
* @throws AccessDeniedException
* You do not have permission to perform this action.
* @sample AWSApplicationCostProfiler.ImportApplicationUsage
* @see AWS API Documentation
*/
ImportApplicationUsageResult importApplicationUsage(ImportApplicationUsageRequest importApplicationUsageRequest);
/**
*
* Retrieves a list of all reports and their configurations for your AWS account.
*
*
* The maximum number of reports is one.
*
*
* @param listReportDefinitionsRequest
* @return Result of the ListReportDefinitions operation returned by the service.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @throws ThrottlingException
* The calls to AWS Application Cost Profiler API are throttled. The request was denied.
* @throws ValidationException
* The input fails to satisfy the constraints for the API.
* @throws AccessDeniedException
* You do not have permission to perform this action.
* @sample AWSApplicationCostProfiler.ListReportDefinitions
* @see AWS API Documentation
*/
ListReportDefinitionsResult listReportDefinitions(ListReportDefinitionsRequest listReportDefinitionsRequest);
/**
*
* Creates the report definition for a report in Application Cost Profiler.
*
*
* @param putReportDefinitionRequest
* @return Result of the PutReportDefinition operation returned by the service.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @throws ThrottlingException
* The calls to AWS Application Cost Profiler API are throttled. The request was denied.
* @throws ValidationException
* The input fails to satisfy the constraints for the API.
* @throws AccessDeniedException
* You do not have permission to perform this action.
* @throws ServiceQuotaExceededException
* Your request exceeds one or more of the service quotas.
* @sample AWSApplicationCostProfiler.PutReportDefinition
* @see AWS API Documentation
*/
PutReportDefinitionResult putReportDefinition(PutReportDefinitionRequest putReportDefinitionRequest);
/**
*
* Updates existing report in AWS Application Cost Profiler.
*
*
* @param updateReportDefinitionRequest
* @return Result of the UpdateReportDefinition operation returned by the service.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @throws ThrottlingException
* The calls to AWS Application Cost Profiler API are throttled. The request was denied.
* @throws ValidationException
* The input fails to satisfy the constraints for the API.
* @throws AccessDeniedException
* You do not have permission to perform this action.
* @sample AWSApplicationCostProfiler.UpdateReportDefinition
* @see AWS API Documentation
*/
UpdateReportDefinitionResult updateReportDefinition(UpdateReportDefinitionRequest updateReportDefinitionRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}