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 staticbuilder()method.This reference provides descriptions of the low-level AWS Artifact Service API.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetAccountSettingsRequest.builder()- Parameters:
getAccountSettingsRequest- AConsumerthat will call methods onGetAccountSettingsRequest.Builderto create a request.- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetReportRequest.builder()- Parameters:
getReportRequest- AConsumerthat will call methods onGetReportRequest.Builderto create a request.- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetReportMetadataRequest.builder()- Parameters:
getReportMetadataRequest- AConsumerthat will call methods onGetReportMetadataRequest.Builderto create a request.- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetTermForReportRequest.builder()- Parameters:
getTermForReportRequest- AConsumerthat will call methods onGetTermForReportRequest.Builderto create a request.- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaListReportsRequest.builder()- Parameters:
listReportsRequest- AConsumerthat will call methods onListReportsRequest.Builderto create a request.- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.artifact.paginators.ListReportsIterable responses = client.listReportsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.
- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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
2) Using For loopsoftware.amazon.awssdk.services.artifact.paginators.ListReportsIterable responses = client.listReportsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListReportsRequest.builder()- Parameters:
listReportsRequest- AConsumerthat will call methods onListReportsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.
- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- 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.Builderavoiding the need to create one manually viaPutAccountSettingsRequest.builder()- Parameters:
putAccountSettingsRequest- AConsumerthat will call methods onPutAccountSettingsRequest.Builderto create a request.- 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.SdkException- 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.ArtifactException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ArtifactClient create()
Create aArtifactClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ArtifactClientBuilder builder()
Create a builder that can be used to configure and create aArtifactClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ArtifactServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-