Interface ArtifactClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface ArtifactClient
extends AwsClient

Service client for accessing AWS Artifact. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static ArtifactClientBuilder	builder()	Create a builder that can be used to configure and create a ArtifactClient.
static ArtifactClient	create()	Create a ArtifactClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetAccountSettingsResponse	getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)	Get the account settings for Artifact.
default GetAccountSettingsResponse	getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)	Get the account settings for Artifact.
default GetReportResponse	getReport(Consumer<GetReportRequest.Builder> getReportRequest)	Get the content for a single report.
default GetReportResponse	getReport(GetReportRequest getReportRequest)	Get the content for a single report.
default GetReportMetadataResponse	getReportMetadata(Consumer<GetReportMetadataRequest.Builder> getReportMetadataRequest)	Get the metadata for a single report.
default GetReportMetadataResponse	getReportMetadata(GetReportMetadataRequest getReportMetadataRequest)	Get the metadata for a single report.
default GetTermForReportResponse	getTermForReport(Consumer<GetTermForReportRequest.Builder> getTermForReportRequest)	Get the Term content associated with a single report.
default GetTermForReportResponse	getTermForReport(GetTermForReportRequest getTermForReportRequest)	Get the Term content associated with a single report.
default ListCustomerAgreementsResponse	listCustomerAgreements(Consumer<ListCustomerAgreementsRequest.Builder> listCustomerAgreementsRequest)	List active customer-agreements applicable to calling identity.
default ListCustomerAgreementsResponse	listCustomerAgreements(ListCustomerAgreementsRequest listCustomerAgreementsRequest)	List active customer-agreements applicable to calling identity.
default ListCustomerAgreementsIterable	listCustomerAgreementsPaginator(Consumer<ListCustomerAgreementsRequest.Builder> listCustomerAgreementsRequest)	This is a variant of listCustomerAgreements(software.amazon.awssdk.services.artifact.model.ListCustomerAgreementsRequest) operation.
default ListCustomerAgreementsIterable	listCustomerAgreementsPaginator(ListCustomerAgreementsRequest listCustomerAgreementsRequest)	This is a variant of listCustomerAgreements(software.amazon.awssdk.services.artifact.model.ListCustomerAgreementsRequest) operation.
default ListReportsResponse	listReports(Consumer<ListReportsRequest.Builder> listReportsRequest)	List available reports.
default ListReportsResponse	listReports(ListReportsRequest listReportsRequest)	List available reports.
default ListReportsIterable	listReportsPaginator(Consumer<ListReportsRequest.Builder> listReportsRequest)	This is a variant of listReports(software.amazon.awssdk.services.artifact.model.ListReportsRequest) operation.
default ListReportsIterable	listReportsPaginator(ListReportsRequest listReportsRequest)	This is a variant of listReports(software.amazon.awssdk.services.artifact.model.ListReportsRequest) operation.
default PutAccountSettingsResponse	putAccountSettings(Consumer<PutAccountSettingsRequest.Builder> putAccountSettingsRequest)	Put the account settings for Artifact.
default PutAccountSettingsResponse	putAccountSettings(PutAccountSettingsRequest putAccountSettingsRequest)	Put the account settings for Artifact.
default ArtifactServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

getAccountSettings

default GetAccountSettingsResponse getAccountSettings(GetAccountSettingsRequest getAccountSettingsRequest)
                                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

Get the account settings for Artifact.

Parameters:

getAccountSettingsRequest -

Returns:

Result of the GetAccountSettings operation returned by the service.

See Also:

• AWS API Documentation

getAccountSettings

default GetAccountSettingsResponse getAccountSettings(Consumer<GetAccountSettingsRequest.Builder> getAccountSettingsRequest)
                                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

Get the account settings for Artifact.

This is a convenience which creates an instance of the GetAccountSettingsRequest.Builder avoiding the need to create one manually via GetAccountSettingsRequest.builder()

Parameters:

getAccountSettingsRequest - A Consumer that will call methods on GetAccountSettingsRequest.Builder to create a request.

Returns:

Result of the GetAccountSettings operation returned by the service.

See Also:

• AWS API Documentation

getReport

default GetReportResponse getReport(GetReportRequest getReportRequest)
                             throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

Get the content for a single report.

Parameters:

getReportRequest -

Returns:

Result of the GetReport operation returned by the service.

See Also:

• AWS API Documentation

getReport

default GetReportResponse getReport(Consumer<GetReportRequest.Builder> getReportRequest)
                             throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

Get the content for a single report.

This is a convenience which creates an instance of the GetReportRequest.Builder avoiding the need to create one manually via GetReportRequest.builder()

Parameters:

getReportRequest - A Consumer that will call methods on GetReportRequest.Builder to create a request.

Returns:

Result of the GetReport operation returned by the service.

See Also:

• AWS API Documentation

getReportMetadata

default GetReportMetadataResponse getReportMetadata(GetReportMetadataRequest getReportMetadataRequest)
                                             throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

Get the metadata for a single report.

Parameters:

getReportMetadataRequest -

Returns:

Result of the GetReportMetadata operation returned by the service.

See Also:

• AWS API Documentation

getReportMetadata

default GetReportMetadataResponse getReportMetadata(Consumer<GetReportMetadataRequest.Builder> getReportMetadataRequest)
                                             throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

Get the metadata for a single report.

This is a convenience which creates an instance of the GetReportMetadataRequest.Builder avoiding the need to create one manually via GetReportMetadataRequest.builder()

Parameters:

getReportMetadataRequest - A Consumer that will call methods on GetReportMetadataRequest.Builder to create a request.

Returns:

Result of the GetReportMetadata operation returned by the service.

See Also:

• AWS API Documentation

getTermForReport

default GetTermForReportResponse getTermForReport(GetTermForReportRequest getTermForReportRequest)
                                           throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

Get the Term content associated with a single report.

Parameters:

getTermForReportRequest -

Returns:

Result of the GetTermForReport operation returned by the service.

See Also:

• AWS API Documentation

getTermForReport

default GetTermForReportResponse getTermForReport(Consumer<GetTermForReportRequest.Builder> getTermForReportRequest)
                                           throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

Get the Term content associated with a single report.

This is a convenience which creates an instance of the GetTermForReportRequest.Builder avoiding the need to create one manually via GetTermForReportRequest.builder()

Parameters:

getTermForReportRequest - A Consumer that will call methods on GetTermForReportRequest.Builder to create a request.

Returns:

Result of the GetTermForReport operation returned by the service.

See Also:

• AWS API Documentation

listCustomerAgreements

default ListCustomerAgreementsResponse listCustomerAgreements(ListCustomerAgreementsRequest listCustomerAgreementsRequest)
                                                       throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
ArtifactException

List active customer-agreements applicable to calling identity.

Parameters:

listCustomerAgreementsRequest -

Returns:

Result of the ListCustomerAgreements operation returned by the service.

See Also:

• AWS API Documentation

listCustomerAgreements

default ListCustomerAgreementsResponse listCustomerAgreements(Consumer<ListCustomerAgreementsRequest.Builder> listCustomerAgreementsRequest)
                                                       throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
ArtifactException

List active customer-agreements applicable to calling identity.

This is a convenience which creates an instance of the ListCustomerAgreementsRequest.Builder avoiding the need to create one manually via ListCustomerAgreementsRequest.builder()

Parameters:

listCustomerAgreementsRequest - A Consumer that will call methods on ListCustomerAgreementsRequest.Builder to create a request.

Returns:

Result of the ListCustomerAgreements operation returned by the service.

See Also:

• AWS API Documentation

listCustomerAgreementsPaginator

default ListCustomerAgreementsIterable listCustomerAgreementsPaginator(ListCustomerAgreementsRequest listCustomerAgreementsRequest)
                                                                throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
ArtifactException

This is a variant of listCustomerAgreements(software.amazon.awssdk.services.artifact.model.ListCustomerAgreementsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.artifact.paginators.ListCustomerAgreementsIterable responses = client.listCustomerAgreementsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.artifact.paginators.ListCustomerAgreementsIterable responses = client
             .listCustomerAgreementsPaginator(request);
     for (software.amazon.awssdk.services.artifact.model.ListCustomerAgreementsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.artifact.paginators.ListCustomerAgreementsIterable responses = client.listCustomerAgreementsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCustomerAgreements(software.amazon.awssdk.services.artifact.model.ListCustomerAgreementsRequest) operation.

Parameters:

listCustomerAgreementsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCustomerAgreementsPaginator

default ListCustomerAgreementsIterable listCustomerAgreementsPaginator(Consumer<ListCustomerAgreementsRequest.Builder> listCustomerAgreementsRequest)
                                                                throws ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
ArtifactException

This is a variant of listCustomerAgreements(software.amazon.awssdk.services.artifact.model.ListCustomerAgreementsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.artifact.paginators.ListCustomerAgreementsIterable responses = client.listCustomerAgreementsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.artifact.paginators.ListCustomerAgreementsIterable responses = client
             .listCustomerAgreementsPaginator(request);
     for (software.amazon.awssdk.services.artifact.model.ListCustomerAgreementsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.artifact.paginators.ListCustomerAgreementsIterable responses = client.listCustomerAgreementsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCustomerAgreements(software.amazon.awssdk.services.artifact.model.ListCustomerAgreementsRequest) operation.

This is a convenience which creates an instance of the ListCustomerAgreementsRequest.Builder avoiding the need to create one manually via ListCustomerAgreementsRequest.builder()

Parameters:

listCustomerAgreementsRequest - A Consumer that will call methods on ListCustomerAgreementsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listReports

default ListReportsResponse listReports(ListReportsRequest listReportsRequest)
                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

List available reports.

Parameters:

listReportsRequest -

Returns:

Result of the ListReports operation returned by the service.

See Also:

• AWS API Documentation

listReports

default ListReportsResponse listReports(Consumer<ListReportsRequest.Builder> listReportsRequest)
                                 throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

List available reports.

This is a convenience which creates an instance of the ListReportsRequest.Builder avoiding the need to create one manually via ListReportsRequest.builder()

Parameters:

listReportsRequest - A Consumer that will call methods on ListReportsRequest.Builder to create a request.

Returns:

Result of the ListReports operation returned by the service.

See Also:

• AWS API Documentation

listReportsPaginator

default ListReportsIterable listReportsPaginator(ListReportsRequest listReportsRequest)
                                          throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

This is a variant of listReports(software.amazon.awssdk.services.artifact.model.ListReportsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.artifact.paginators.ListReportsIterable responses = client.listReportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.artifact.paginators.ListReportsIterable responses = client.listReportsPaginator(request);
     for (software.amazon.awssdk.services.artifact.model.ListReportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.artifact.paginators.ListReportsIterable responses = client.listReportsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listReports(software.amazon.awssdk.services.artifact.model.ListReportsRequest) operation.

Parameters:

listReportsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listReportsPaginator

default ListReportsIterable listReportsPaginator(Consumer<ListReportsRequest.Builder> listReportsRequest)
                                          throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

This is a variant of listReports(software.amazon.awssdk.services.artifact.model.ListReportsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.artifact.paginators.ListReportsIterable responses = client.listReportsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.artifact.paginators.ListReportsIterable responses = client.listReportsPaginator(request);
     for (software.amazon.awssdk.services.artifact.model.ListReportsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.artifact.paginators.ListReportsIterable responses = client.listReportsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listReports(software.amazon.awssdk.services.artifact.model.ListReportsRequest) operation.

This is a convenience which creates an instance of the ListReportsRequest.Builder avoiding the need to create one manually via ListReportsRequest.builder()

Parameters:

listReportsRequest - A Consumer that will call methods on ListReportsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

putAccountSettings

default PutAccountSettingsResponse putAccountSettings(PutAccountSettingsRequest putAccountSettingsRequest)
                                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

Put the account settings for Artifact.

Parameters:

putAccountSettingsRequest -

Returns:

Result of the PutAccountSettings operation returned by the service.

See Also:

• AWS API Documentation

putAccountSettings

default PutAccountSettingsResponse putAccountSettings(Consumer<PutAccountSettingsRequest.Builder> putAccountSettingsRequest)
                                               throws ResourceNotFoundException,
ThrottlingException,
AccessDeniedException,
ConflictException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
ArtifactException

Put the account settings for Artifact.

This is a convenience which creates an instance of the PutAccountSettingsRequest.Builder avoiding the need to create one manually via PutAccountSettingsRequest.builder()

Parameters:

putAccountSettingsRequest - A Consumer that will call methods on PutAccountSettingsRequest.Builder to create a request.

Returns:

Result of the PutAccountSettings operation returned by the service.

See Also:

• AWS API Documentation

create

static ArtifactClient create()

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

builder

static ArtifactClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ArtifactServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration