com.amazonaws.services.artifact

Class AWSArtifactClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.artifact.AWSArtifactClient

All Implemented Interfaces:

AWSArtifact

Direct Known Subclasses:

AWSArtifactAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSArtifactClient
extends AmazonWebServiceClient
implements AWSArtifact

Client for accessing AWS Artifact. All service calls made using this client are blocking, and will not return until the service call completes.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.artifact.AWSArtifact

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSArtifactClientBuilder	builder()
GetAccountSettingsResult	getAccountSettings(GetAccountSettingsRequest request) 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 request) Get the content for a single report.
GetReportMetadataResult	getReportMetadata(GetReportMetadataRequest request) Get the metadata for a single report.
GetTermForReportResult	getTermForReport(GetTermForReportRequest request) Get the Term content associated with a single report.
ListReportsResult	listReports(ListReportsRequest request) List available reports.
PutAccountSettingsResult	putAccountSettings(PutAccountSettingsRequest request) Put the account settings for Artifact.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSArtifactClientBuilder builder()

getAccountSettings

public GetAccountSettingsResult getAccountSettings(GetAccountSettingsRequest request)

Get the account settings for Artifact.

Specified by:

getAccountSettings in interface AWSArtifact

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

public GetReportResult getReport(GetReportRequest request)

Get the content for a single report.

Specified by:

getReport in interface AWSArtifact

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

public GetReportMetadataResult getReportMetadata(GetReportMetadataRequest request)

Get the metadata for a single report.

Specified by:

getReportMetadata in interface AWSArtifact

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

public GetTermForReportResult getTermForReport(GetTermForReportRequest request)

Get the Term content associated with a single report.

Specified by:

getTermForReport in interface AWSArtifact

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

public ListReportsResult listReports(ListReportsRequest request)

List available reports.

Specified by:

listReports in interface AWSArtifact

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

public PutAccountSettingsResult putAccountSettings(PutAccountSettingsRequest request)

Put the account settings for Artifact.

Specified by:

putAccountSettings in interface AWSArtifact

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSArtifact

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from interface: AWSArtifact

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.

Specified by:

shutdown in interface AWSArtifact

Overrides:

shutdown in class AmazonWebServiceClient