com.amazonaws.services.artifact

Interface AWSArtifact

All Known Subinterfaces:

AWSArtifactAsync

All Known Implementing Classes:

AbstractAWSArtifact, AbstractAWSArtifactAsync, AWSArtifactAsyncClient, AWSArtifactClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSArtifact

Interface for accessing AWS Artifact.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSArtifact instead.

This reference provides descriptions of the low-level AWS Artifact Service API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
GetAccountSettingsResult	getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest) Get the account settings for Artifact.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetReportResult	getReport(GetReportRequest getReportRequest) Get the content for a single report.
GetReportMetadataResult	getReportMetadata(GetReportMetadataRequest getReportMetadataRequest) Get the metadata for a single report.
GetTermForReportResult	getTermForReport(GetTermForReportRequest getTermForReportRequest) Get the Term content associated with a single report.
ListReportsResult	listReports(ListReportsRequest listReportsRequest) List available reports.
PutAccountSettingsResult	putAccountSettings(PutAccountSettingsRequest putAccountSettingsRequest) Put the account settings for Artifact.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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 Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

getAccountSettings

GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)

Get the account settings for Artifact.

Parameters:

getAccountSettingsRequest -

Returns:

Result of the GetAccountSettings operation returned by the service.

Throws:

ResourceNotFoundException - Request references a resource which does not exist.

ThrottlingException - Request was denied due to request throttling.

AccessDeniedException - User does not have sufficient access to perform this action.

ConflictException - Request to create/modify content would result in a conflict.

InternalServerException - An unknown server exception has occurred.

ValidationException - Request fails to satisfy the constraints specified by an AWS service.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

See Also:

AWS API Documentation

getReport

GetReportResult getReport(GetReportRequest getReportRequest)

Get the content for a single report.

Parameters:

getReportRequest -

Returns:

Result of the GetReport operation returned by the service.

Throws:

ResourceNotFoundException - Request references a resource which does not exist.

ThrottlingException - Request was denied due to request throttling.

AccessDeniedException - User does not have sufficient access to perform this action.

ConflictException - Request to create/modify content would result in a conflict.

InternalServerException - An unknown server exception has occurred.

ValidationException - Request fails to satisfy the constraints specified by an AWS service.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

See Also:

AWS API Documentation

getReportMetadata

GetReportMetadataResult getReportMetadata(GetReportMetadataRequest getReportMetadataRequest)

Get the metadata for a single report.

Parameters:

getReportMetadataRequest -

Returns:

Result of the GetReportMetadata operation returned by the service.

Throws:

ResourceNotFoundException - Request references a resource which does not exist.

ThrottlingException - Request was denied due to request throttling.

AccessDeniedException - User does not have sufficient access to perform this action.

InternalServerException - An unknown server exception has occurred.

ValidationException - Request fails to satisfy the constraints specified by an AWS service.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

See Also:

AWS API Documentation

getTermForReport

GetTermForReportResult getTermForReport(GetTermForReportRequest getTermForReportRequest)

Get the Term content associated with a single report.

Parameters:

getTermForReportRequest -

Returns:

Result of the GetTermForReport operation returned by the service.

Throws:

ResourceNotFoundException - Request references a resource which does not exist.

ThrottlingException - Request was denied due to request throttling.

AccessDeniedException - User does not have sufficient access to perform this action.

ConflictException - Request to create/modify content would result in a conflict.

InternalServerException - An unknown server exception has occurred.

ValidationException - Request fails to satisfy the constraints specified by an AWS service.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

See Also:

AWS API Documentation

listReports

ListReportsResult listReports(ListReportsRequest listReportsRequest)

List available reports.

Parameters:

listReportsRequest -

Returns:

Result of the ListReports operation returned by the service.

Throws:

ResourceNotFoundException - Request references a resource which does not exist.

ThrottlingException - Request was denied due to request throttling.

AccessDeniedException - User does not have sufficient access to perform this action.

InternalServerException - An unknown server exception has occurred.

ValidationException - Request fails to satisfy the constraints specified by an AWS service.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

See Also:

AWS API Documentation

putAccountSettings

PutAccountSettingsResult putAccountSettings(PutAccountSettingsRequest putAccountSettingsRequest)

Put the account settings for Artifact.

Parameters:

putAccountSettingsRequest -

Returns:

Result of the PutAccountSettings operation returned by the service.

Throws:

ResourceNotFoundException - Request references a resource which does not exist.

ThrottlingException - Request was denied due to request throttling.

AccessDeniedException - User does not have sufficient access to perform this action.

ConflictException - Request to create/modify content would result in a conflict.

InternalServerException - An unknown server exception has occurred.

ValidationException - Request fails to satisfy the constraints specified by an AWS service.

ServiceQuotaExceededException - Request would cause a service quota to be exceeded.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.