Interface MarketplaceCatalogAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An entity can be a product or an offer on AWS Marketplace.
You can automate your entity update process by integrating the AWS Marketplace Catalog API with your AWS Marketplace product build or deployment pipelines. You can also create your own applications on top of the Catalog API to manage your products on AWS Marketplace.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchDescribeEntities
(Consumer<BatchDescribeEntitiesRequest.Builder> batchDescribeEntitiesRequest) Returns metadata and content for multiple entities.batchDescribeEntities
(BatchDescribeEntitiesRequest batchDescribeEntitiesRequest) Returns metadata and content for multiple entities.builder()
Create a builder that can be used to configure and create aMarketplaceCatalogAsyncClient
.default CompletableFuture
<CancelChangeSetResponse> cancelChangeSet
(Consumer<CancelChangeSetRequest.Builder> cancelChangeSetRequest) Used to cancel an open change request.default CompletableFuture
<CancelChangeSetResponse> cancelChangeSet
(CancelChangeSetRequest cancelChangeSetRequest) Used to cancel an open change request.create()
Create aMarketplaceCatalogAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.deleteResourcePolicy
(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes a resource-based policy on an entity that is identified by its resource ARN.deleteResourcePolicy
(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes a resource-based policy on an entity that is identified by its resource ARN.describeChangeSet
(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest) Provides information about a given change set.describeChangeSet
(DescribeChangeSetRequest describeChangeSetRequest) Provides information about a given change set.default CompletableFuture
<DescribeEntityResponse> describeEntity
(Consumer<DescribeEntityRequest.Builder> describeEntityRequest) Returns the metadata and content of the entity.default CompletableFuture
<DescribeEntityResponse> describeEntity
(DescribeEntityRequest describeEntityRequest) Returns the metadata and content of the entity.getResourcePolicy
(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Gets a resource-based policy of an entity that is identified by its resource ARN.getResourcePolicy
(GetResourcePolicyRequest getResourcePolicyRequest) Gets a resource-based policy of an entity that is identified by its resource ARN.default CompletableFuture
<ListChangeSetsResponse> listChangeSets
(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) Returns the list of change sets owned by the account being used to make the call.default CompletableFuture
<ListChangeSetsResponse> listChangeSets
(ListChangeSetsRequest listChangeSetsRequest) Returns the list of change sets owned by the account being used to make the call.default ListChangeSetsPublisher
listChangeSetsPaginator
(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) This is a variant oflistChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest)
operation.default ListChangeSetsPublisher
listChangeSetsPaginator
(ListChangeSetsRequest listChangeSetsRequest) This is a variant oflistChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest)
operation.default CompletableFuture
<ListEntitiesResponse> listEntities
(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest) Provides the list of entities of a given type.default CompletableFuture
<ListEntitiesResponse> listEntities
(ListEntitiesRequest listEntitiesRequest) Provides the list of entities of a given type.default ListEntitiesPublisher
listEntitiesPaginator
(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest) This is a variant oflistEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest)
operation.default ListEntitiesPublisher
listEntitiesPaginator
(ListEntitiesRequest listEntitiesRequest) This is a variant oflistEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags that have been added to a resource (either an entity or change set).listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags that have been added to a resource (either an entity or change set).putResourcePolicy
(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Attaches a resource-based policy to an entity.putResourcePolicy
(PutResourcePolicyRequest putResourcePolicyRequest) Attaches a resource-based policy to an entity.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StartChangeSetResponse> startChangeSet
(Consumer<StartChangeSetRequest.Builder> startChangeSetRequest) Allows you to request changes for your entities.default CompletableFuture
<StartChangeSetResponse> startChangeSet
(StartChangeSetRequest startChangeSetRequest) Allows you to request changes for your entities.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tags a resource (either an entity or change set).default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Tags a resource (either an entity or change set).default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag or list of tags from a resource (either an entity or change set).default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag or list of tags from a resource (either an entity or change set).Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchDescribeEntities
default CompletableFuture<BatchDescribeEntitiesResponse> batchDescribeEntities(BatchDescribeEntitiesRequest batchDescribeEntitiesRequest) Returns metadata and content for multiple entities. This is the Batch version of the
DescribeEntity
API and uses the same IAM permission action asDescribeEntity
API.- Parameters:
batchDescribeEntitiesRequest
-- Returns:
- A Java Future containing the result of the BatchDescribeEntities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Access is denied.
HTTP status code: 403
- InternalServiceException There was an internal service exception.
HTTP status code: 500
- ThrottlingException Too many requests.
HTTP status code: 429
- ValidationException An error occurred during validation.
HTTP status code: 422
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException Access is denied.
- See Also:
-
batchDescribeEntities
default CompletableFuture<BatchDescribeEntitiesResponse> batchDescribeEntities(Consumer<BatchDescribeEntitiesRequest.Builder> batchDescribeEntitiesRequest) Returns metadata and content for multiple entities. This is the Batch version of the
DescribeEntity
API and uses the same IAM permission action asDescribeEntity
API.
This is a convenience which creates an instance of the
BatchDescribeEntitiesRequest.Builder
avoiding the need to create one manually viaBatchDescribeEntitiesRequest.builder()
- Parameters:
batchDescribeEntitiesRequest
- AConsumer
that will call methods onBatchDescribeEntitiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchDescribeEntities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- AccessDeniedException Access is denied.
HTTP status code: 403
- InternalServiceException There was an internal service exception.
HTTP status code: 500
- ThrottlingException Too many requests.
HTTP status code: 429
- ValidationException An error occurred during validation.
HTTP status code: 422
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException Access is denied.
- See Also:
-
cancelChangeSet
default CompletableFuture<CancelChangeSetResponse> cancelChangeSet(CancelChangeSetRequest cancelChangeSetRequest) Used to cancel an open change request. Must be sent before the status of the request changes to
APPLYING
, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.- Parameters:
cancelChangeSetRequest
-- Returns:
- A Java Future containing the result of the CancelChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ResourceInUseException The resource is currently in use.
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
cancelChangeSet
default CompletableFuture<CancelChangeSetResponse> cancelChangeSet(Consumer<CancelChangeSetRequest.Builder> cancelChangeSetRequest) Used to cancel an open change request. Must be sent before the status of the request changes to
APPLYING
, the final stage of completing your change request. You can describe a change during the 60-day request history retention period for API calls.
This is a convenience which creates an instance of the
CancelChangeSetRequest.Builder
avoiding the need to create one manually viaCancelChangeSetRequest.builder()
- Parameters:
cancelChangeSetRequest
- AConsumer
that will call methods onCancelChangeSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ResourceInUseException The resource is currently in use.
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes a resource-based policy on an entity that is identified by its resource ARN.
- Parameters:
deleteResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes a resource-based policy on an entity that is identified by its resource ARN.
This is a convenience which creates an instance of the
DeleteResourcePolicyRequest.Builder
avoiding the need to create one manually viaDeleteResourcePolicyRequest.builder()
- Parameters:
deleteResourcePolicyRequest
- AConsumer
that will call methods onDeleteResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
describeChangeSet
default CompletableFuture<DescribeChangeSetResponse> describeChangeSet(DescribeChangeSetRequest describeChangeSetRequest) Provides information about a given change set.
- Parameters:
describeChangeSetRequest
-- Returns:
- A Java Future containing the result of the DescribeChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
describeChangeSet
default CompletableFuture<DescribeChangeSetResponse> describeChangeSet(Consumer<DescribeChangeSetRequest.Builder> describeChangeSetRequest) Provides information about a given change set.
This is a convenience which creates an instance of the
DescribeChangeSetRequest.Builder
avoiding the need to create one manually viaDescribeChangeSetRequest.builder()
- Parameters:
describeChangeSetRequest
- AConsumer
that will call methods onDescribeChangeSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
describeEntity
default CompletableFuture<DescribeEntityResponse> describeEntity(DescribeEntityRequest describeEntityRequest) Returns the metadata and content of the entity.
- Parameters:
describeEntityRequest
-- Returns:
- A Java Future containing the result of the DescribeEntity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotSupportedException Currently, the specified resource is not supported.
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
describeEntity
default CompletableFuture<DescribeEntityResponse> describeEntity(Consumer<DescribeEntityRequest.Builder> describeEntityRequest) Returns the metadata and content of the entity.
This is a convenience which creates an instance of the
DescribeEntityRequest.Builder
avoiding the need to create one manually viaDescribeEntityRequest.builder()
- Parameters:
describeEntityRequest
- AConsumer
that will call methods onDescribeEntityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEntity operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotSupportedException Currently, the specified resource is not supported.
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) Gets a resource-based policy of an entity that is identified by its resource ARN.
- Parameters:
getResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
getResourcePolicy
default CompletableFuture<GetResourcePolicyResponse> getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) Gets a resource-based policy of an entity that is identified by its resource ARN.
This is a convenience which creates an instance of the
GetResourcePolicyRequest.Builder
avoiding the need to create one manually viaGetResourcePolicyRequest.builder()
- Parameters:
getResourcePolicyRequest
- AConsumer
that will call methods onGetResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
listChangeSets
default CompletableFuture<ListChangeSetsResponse> listChangeSets(ListChangeSetsRequest listChangeSetsRequest) Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of
entityId
,ChangeSetName
, and status. If you provide more than one filter, the API operation applies a logical AND between the filters.You can describe a change during the 60-day request history retention period for API calls.
- Parameters:
listChangeSetsRequest
-- Returns:
- A Java Future containing the result of the ListChangeSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
listChangeSets
default CompletableFuture<ListChangeSetsResponse> listChangeSets(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) Returns the list of change sets owned by the account being used to make the call. You can filter this list by providing any combination of
entityId
,ChangeSetName
, and status. If you provide more than one filter, the API operation applies a logical AND between the filters.You can describe a change during the 60-day request history retention period for API calls.
This is a convenience which creates an instance of the
ListChangeSetsRequest.Builder
avoiding the need to create one manually viaListChangeSetsRequest.builder()
- Parameters:
listChangeSetsRequest
- AConsumer
that will call methods onListChangeSetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListChangeSets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
listChangeSetsPaginator
default ListChangeSetsPublisher listChangeSetsPaginator(ListChangeSetsRequest listChangeSetsRequest) This is a variant of
listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsResponse response) { //... }; });
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
listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest)
operation.- Parameters:
listChangeSetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
listChangeSetsPaginator
default ListChangeSetsPublisher listChangeSetsPaginator(Consumer<ListChangeSetsRequest.Builder> listChangeSetsRequest) This is a variant of
listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.marketplacecatalog.paginators.ListChangeSetsPublisher publisher = client.listChangeSetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsResponse response) { //... }; });
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
listChangeSets(software.amazon.awssdk.services.marketplacecatalog.model.ListChangeSetsRequest)
operation.
This is a convenience which creates an instance of the
ListChangeSetsRequest.Builder
avoiding the need to create one manually viaListChangeSetsRequest.builder()
- Parameters:
listChangeSetsRequest
- AConsumer
that will call methods onListChangeSetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
listEntities
default CompletableFuture<ListEntitiesResponse> listEntities(ListEntitiesRequest listEntitiesRequest) Provides the list of entities of a given type.
- Parameters:
listEntitiesRequest
-- Returns:
- A Java Future containing the result of the ListEntities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
listEntities
default CompletableFuture<ListEntitiesResponse> listEntities(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest) Provides the list of entities of a given type.
This is a convenience which creates an instance of the
ListEntitiesRequest.Builder
avoiding the need to create one manually viaListEntitiesRequest.builder()
- Parameters:
listEntitiesRequest
- AConsumer
that will call methods onListEntitiesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEntities operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
listEntitiesPaginator
This is a variant of
listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesResponse response) { //... }; });
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
listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest)
operation.- Parameters:
listEntitiesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
listEntitiesPaginator
default ListEntitiesPublisher listEntitiesPaginator(Consumer<ListEntitiesRequest.Builder> listEntitiesRequest) This is a variant of
listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.marketplacecatalog.paginators.ListEntitiesPublisher publisher = client.listEntitiesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesResponse response) { //... }; });
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
listEntities(software.amazon.awssdk.services.marketplacecatalog.model.ListEntitiesRequest)
operation.
This is a convenience which creates an instance of the
ListEntitiesRequest.Builder
avoiding the need to create one manually viaListEntitiesRequest.builder()
- Parameters:
listEntitiesRequest
- AConsumer
that will call methods onListEntitiesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags that have been added to a resource (either an entity or change set).
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource wasn't found.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags that have been added to a resource (either an entity or change set).
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource wasn't found.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) Attaches a resource-based policy to an entity. Examples of an entity include:
AmiProduct
andContainerProduct
.- Parameters:
putResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Attaches a resource-based policy to an entity. Examples of an entity include:
AmiProduct
andContainerProduct
.
This is a convenience which creates an instance of the
PutResourcePolicyRequest.Builder
avoiding the need to create one manually viaPutResourcePolicyRequest.builder()
- Parameters:
putResourcePolicyRequest
- AConsumer
that will call methods onPutResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
startChangeSet
default CompletableFuture<StartChangeSetResponse> startChangeSet(StartChangeSetRequest startChangeSetRequest) Allows you to request changes for your entities. Within a single
ChangeSet
, you can't start the same change type against the same entity multiple times. Additionally, when aChangeSet
is running, all the entities targeted by the different changes are locked until the change set has completed (either succeeded, cancelled, or failed). If you try to start a change set containing a change against an entity that is already locked, you will receive aResourceInUseException
error.For example, you can't start the
ChangeSet
described in the example later in this topic because it contains two changes to run the same change type (AddRevisions
) against the same entity (entity-id@1
).For more information about working with change sets, see Working with change sets. For information about change types for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for container-based products, see Working with container products.
To download "DetailsDocument" shapes, see Python and Java shapes on GitHub.
- Parameters:
startChangeSetRequest
-- Returns:
- A Java Future containing the result of the StartChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ResourceInUseException The resource is currently in use.
- ThrottlingException Too many requests.
HTTP status code: 429
- ServiceQuotaExceededException The maximum number of open requests per account has been 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
startChangeSet
default CompletableFuture<StartChangeSetResponse> startChangeSet(Consumer<StartChangeSetRequest.Builder> startChangeSetRequest) Allows you to request changes for your entities. Within a single
ChangeSet
, you can't start the same change type against the same entity multiple times. Additionally, when aChangeSet
is running, all the entities targeted by the different changes are locked until the change set has completed (either succeeded, cancelled, or failed). If you try to start a change set containing a change against an entity that is already locked, you will receive aResourceInUseException
error.For example, you can't start the
ChangeSet
described in the example later in this topic because it contains two changes to run the same change type (AddRevisions
) against the same entity (entity-id@1
).For more information about working with change sets, see Working with change sets. For information about change types for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for container-based products, see Working with container products.
To download "DetailsDocument" shapes, see Python and Java shapes on GitHub.
This is a convenience which creates an instance of the
StartChangeSetRequest.Builder
avoiding the need to create one manually viaStartChangeSetRequest.builder()
- Parameters:
startChangeSetRequest
- AConsumer
that will call methods onStartChangeSetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartChangeSet operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- ResourceInUseException The resource is currently in use.
- ThrottlingException Too many requests.
HTTP status code: 429
- ServiceQuotaExceededException The maximum number of open requests per account has been 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InternalServiceException There was an internal service exception.
- See Also:
-
tagResource
Tags a resource (either an entity or change set).
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource wasn't found.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tags a resource (either an entity or change set).
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource wasn't found.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes a tag or list of tags from a resource (either an entity or change set).
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource wasn't found.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag or list of tags from a resource (either an entity or change set).
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource wasn't found.
HTTP status code: 404
- InternalServiceException There was an internal service exception.
HTTP status code: 500
- AccessDeniedException Access is denied.
HTTP status code: 403
- ValidationException An error occurred during validation.
HTTP status code: 422
- ThrottlingException Too many requests.
HTTP status code: 429
- 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.
- MarketplaceCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource wasn't found.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aMarketplaceCatalogAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMarketplaceCatalogAsyncClient
.
-