Interface AgentRegistryControlAsyncClient
- 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.
AWS Agent Registry is a managed catalog for publishing and discovering resources such as MCP servers, agents, and agent skills. Agent Registry Control is its control-plane API: use it to create and manage registries and the records they contain, configure discovery and authorization, govern record approval and curation workflows, and manage automatic detection of resources. Data-plane search and MCP invocation operations are provided by the companion Agent Registry API.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Create a builder that can be used to configure and create aAgentRegistryControlAsyncClient.create()Create aAgentRegistryControlAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<CreateRegistryResponse> createRegistry(Consumer<CreateRegistryRequest.Builder> createRegistryRequest) Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior.default CompletableFuture<CreateRegistryResponse> createRegistry(CreateRegistryRequest createRegistryRequest) Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior.createRegistryRecord(Consumer<CreateRegistryRecordRequest.Builder> createRegistryRecordRequest) Creates a registry record within a registry.createRegistryRecord(CreateRegistryRecordRequest createRegistryRecordRequest) Creates a registry record within a registry.default CompletableFuture<DeleteRegistryResponse> deleteRegistry(Consumer<DeleteRegistryRequest.Builder> deleteRegistryRequest) Deletes a registry.default CompletableFuture<DeleteRegistryResponse> deleteRegistry(DeleteRegistryRequest deleteRegistryRequest) Deletes a registry.deleteRegistryRecord(Consumer<DeleteRegistryRecordRequest.Builder> deleteRegistryRecordRequest) Deletes a registry recorddeleteRegistryRecord(DeleteRegistryRecordRequest deleteRegistryRecordRequest) Deletes a registry recorddefault CompletableFuture<GetRegistryResponse> getRegistry(Consumer<GetRegistryRequest.Builder> getRegistryRequest) Gets a registry by identifier (ARN or ID)default CompletableFuture<GetRegistryResponse> getRegistry(GetRegistryRequest getRegistryRequest) Gets a registry by identifier (ARN or ID)getRegistryRecord(Consumer<GetRegistryRecordRequest.Builder> getRegistryRecordRequest) Retrieves the details of a registry recordgetRegistryRecord(GetRegistryRecordRequest getRegistryRecordRequest) Retrieves the details of a registry recorddefault CompletableFuture<ListRegistriesResponse> listRegistries(Consumer<ListRegistriesRequest.Builder> listRegistriesRequest) Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer typedefault CompletableFuture<ListRegistriesResponse> listRegistries(ListRegistriesRequest listRegistriesRequest) Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer typedefault ListRegistriesPublisherlistRegistriesPaginator(Consumer<ListRegistriesRequest.Builder> listRegistriesRequest) This is a variant oflistRegistries(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesRequest)operation.default ListRegistriesPublisherlistRegistriesPaginator(ListRegistriesRequest listRegistriesRequest) This is a variant oflistRegistries(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesRequest)operation.listRegistryRecords(Consumer<ListRegistryRecordsRequest.Builder> listRegistryRecordsRequest) Lists the registry records within a registry, with optional filtering by name, status, and record typelistRegistryRecords(ListRegistryRecordsRequest listRegistryRecordsRequest) Lists the registry records within a registry, with optional filtering by name, status, and record typedefault ListRegistryRecordsPublisherlistRegistryRecordsPaginator(Consumer<ListRegistryRecordsRequest.Builder> listRegistryRecordsRequest) This is a variant oflistRegistryRecords(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsRequest)operation.default ListRegistryRecordsPublisherlistRegistryRecordsPaginator(ListRegistryRecordsRequest listRegistryRecordsRequest) This is a variant oflistRegistryRecords(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags on a resourcelistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List the tags on a resourceThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationsubmitRegistryRecordForApproval(Consumer<SubmitRegistryRecordForApprovalRequest.Builder> submitRegistryRecordForApprovalRequest) Submits a DRAFT registry record for approval, moving it into the registry's approval workflow.submitRegistryRecordForApproval(SubmitRegistryRecordForApprovalRequest submitRegistryRecordForApprovalRequest) Submits a DRAFT registry record for approval, moving it into the registry's approval workflow.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tag a resource with key-value pairsdefault CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Tag a resource with key-value pairsdefault CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove tags from a resource by keydefault CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Remove tags from a resource by keydefault CompletableFuture<UpdateRegistryResponse> updateRegistry(Consumer<UpdateRegistryRequest.Builder> updateRegistryRequest) Updates an existing registry.default CompletableFuture<UpdateRegistryResponse> updateRegistry(UpdateRegistryRequest updateRegistryRequest) Updates an existing registry.updateRegistryRecord(Consumer<UpdateRegistryRecordRequest.Builder> updateRegistryRecordRequest) Updates a registry record.updateRegistryRecord(UpdateRegistryRecordRequest updateRegistryRecordRequest) Updates a registry record.updateRegistryRecordStatus(Consumer<UpdateRegistryRecordStatusRequest.Builder> updateRegistryRecordStatusRequest) Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverableupdateRegistryRecordStatus(UpdateRegistryRecordStatusRequest updateRegistryRecordStatusRequest) Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverabledefault AgentRegistryControlAsyncWaiterwaiter()Create an instance ofAgentRegistryControlAsyncWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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
-
createRegistry
default CompletableFuture<CreateRegistryResponse> createRegistry(CreateRegistryRequest createRegistryRequest) Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior. Creation is asynchronous: the registry begins in the CREATING status and becomes usable once it reaches READY.
- Parameters:
createRegistryRequest- Request structure for creating a registry- Returns:
- A Java Future containing the result of the CreateRegistry 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ServiceQuotaExceededException The request would exceed a service quota.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRegistry
default CompletableFuture<CreateRegistryResponse> createRegistry(Consumer<CreateRegistryRequest.Builder> createRegistryRequest) Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior. Creation is asynchronous: the registry begins in the CREATING status and becomes usable once it reaches READY.
This is a convenience which creates an instance of the
CreateRegistryRequest.Builderavoiding the need to create one manually viaCreateRegistryRequest.builder()- Parameters:
createRegistryRequest- AConsumerthat will call methods onCreateRegistryRequest.Builderto create a request. Request structure for creating a registry- Returns:
- A Java Future containing the result of the CreateRegistry 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ServiceQuotaExceededException The request would exceed a service quota.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRegistryRecord
default CompletableFuture<CreateRegistryRecordResponse> createRegistryRecord(CreateRegistryRecordRequest createRegistryRecordRequest) Creates a registry record within a registry. A registry record describes a discoverable resource, such as an MCP server, an agent, an agent skill, or a custom resource. Creation is asynchronous: the record is returned with the CREATING status while it is processed.
- Parameters:
createRegistryRecordRequest-- Returns:
- A Java Future containing the result of the CreateRegistryRecord 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ServiceQuotaExceededException The request would exceed a service quota.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRegistryRecord
default CompletableFuture<CreateRegistryRecordResponse> createRegistryRecord(Consumer<CreateRegistryRecordRequest.Builder> createRegistryRecordRequest) Creates a registry record within a registry. A registry record describes a discoverable resource, such as an MCP server, an agent, an agent skill, or a custom resource. Creation is asynchronous: the record is returned with the CREATING status while it is processed.
This is a convenience which creates an instance of the
CreateRegistryRecordRequest.Builderavoiding the need to create one manually viaCreateRegistryRecordRequest.builder()- Parameters:
createRegistryRecordRequest- AConsumerthat will call methods onCreateRegistryRecordRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateRegistryRecord 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ServiceQuotaExceededException The request would exceed a service quota.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRegistry
default CompletableFuture<DeleteRegistryResponse> deleteRegistry(DeleteRegistryRequest deleteRegistryRequest) Deletes a registry. Deletion is asynchronous: the registry transitions to the DELETING status and is removed along with its registry records.
- Parameters:
deleteRegistryRequest- Request structure for deleting a registry- Returns:
- A Java Future containing the result of the DeleteRegistry 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRegistry
default CompletableFuture<DeleteRegistryResponse> deleteRegistry(Consumer<DeleteRegistryRequest.Builder> deleteRegistryRequest) Deletes a registry. Deletion is asynchronous: the registry transitions to the DELETING status and is removed along with its registry records.
This is a convenience which creates an instance of the
DeleteRegistryRequest.Builderavoiding the need to create one manually viaDeleteRegistryRequest.builder()- Parameters:
deleteRegistryRequest- AConsumerthat will call methods onDeleteRegistryRequest.Builderto create a request. Request structure for deleting a registry- Returns:
- A Java Future containing the result of the DeleteRegistry 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRegistryRecord
default CompletableFuture<DeleteRegistryRecordResponse> deleteRegistryRecord(DeleteRegistryRecordRequest deleteRegistryRecordRequest) Deletes a registry record
- Parameters:
deleteRegistryRecordRequest-- Returns:
- A Java Future containing the result of the DeleteRegistryRecord 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRegistryRecord
default CompletableFuture<DeleteRegistryRecordResponse> deleteRegistryRecord(Consumer<DeleteRegistryRecordRequest.Builder> deleteRegistryRecordRequest) Deletes a registry record
This is a convenience which creates an instance of the
DeleteRegistryRecordRequest.Builderavoiding the need to create one manually viaDeleteRegistryRecordRequest.builder()- Parameters:
deleteRegistryRecordRequest- AConsumerthat will call methods onDeleteRegistryRecordRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteRegistryRecord 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegistry
Gets a registry by identifier (ARN or ID)
- Parameters:
getRegistryRequest- Request structure for getting a registry- Returns:
- A Java Future containing the result of the GetRegistry 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegistry
default CompletableFuture<GetRegistryResponse> getRegistry(Consumer<GetRegistryRequest.Builder> getRegistryRequest) Gets a registry by identifier (ARN or ID)
This is a convenience which creates an instance of the
GetRegistryRequest.Builderavoiding the need to create one manually viaGetRegistryRequest.builder()- Parameters:
getRegistryRequest- AConsumerthat will call methods onGetRegistryRequest.Builderto create a request. Request structure for getting a registry- Returns:
- A Java Future containing the result of the GetRegistry 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegistryRecord
default CompletableFuture<GetRegistryRecordResponse> getRegistryRecord(GetRegistryRecordRequest getRegistryRecordRequest) Retrieves the details of a registry record
- Parameters:
getRegistryRecordRequest-- Returns:
- A Java Future containing the result of the GetRegistryRecord 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegistryRecord
default CompletableFuture<GetRegistryRecordResponse> getRegistryRecord(Consumer<GetRegistryRecordRequest.Builder> getRegistryRecordRequest) Retrieves the details of a registry record
This is a convenience which creates an instance of the
GetRegistryRecordRequest.Builderavoiding the need to create one manually viaGetRegistryRecordRequest.builder()- Parameters:
getRegistryRecordRequest- AConsumerthat will call methods onGetRegistryRecordRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetRegistryRecord 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistries
default CompletableFuture<ListRegistriesResponse> listRegistries(ListRegistriesRequest listRegistriesRequest) Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer type
- Parameters:
listRegistriesRequest- Request structure for listing registries- Returns:
- A Java Future containing the result of the ListRegistries 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistries
default CompletableFuture<ListRegistriesResponse> listRegistries(Consumer<ListRegistriesRequest.Builder> listRegistriesRequest) Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer type
This is a convenience which creates an instance of the
ListRegistriesRequest.Builderavoiding the need to create one manually viaListRegistriesRequest.builder()- Parameters:
listRegistriesRequest- AConsumerthat will call methods onListRegistriesRequest.Builderto create a request. Request structure for listing registries- Returns:
- A Java Future containing the result of the ListRegistries 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistriesPaginator
default ListRegistriesPublisher listRegistriesPaginator(ListRegistriesRequest listRegistriesRequest) This is a variant of
listRegistries(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistriesPublisher publisher = client.listRegistriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistriesPublisher publisher = client.listRegistriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesResponse 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
listRegistries(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesRequest)operation.- Parameters:
listRegistriesRequest- Request structure for listing registries- 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistriesPaginator
default ListRegistriesPublisher listRegistriesPaginator(Consumer<ListRegistriesRequest.Builder> listRegistriesRequest) This is a variant of
listRegistries(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistriesPublisher publisher = client.listRegistriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistriesPublisher publisher = client.listRegistriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesResponse 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
listRegistries(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesRequest)operation.
This is a convenience which creates an instance of the
ListRegistriesRequest.Builderavoiding the need to create one manually viaListRegistriesRequest.builder()- Parameters:
listRegistriesRequest- AConsumerthat will call methods onListRegistriesRequest.Builderto create a request. Request structure for listing registries- 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistryRecords
default CompletableFuture<ListRegistryRecordsResponse> listRegistryRecords(ListRegistryRecordsRequest listRegistryRecordsRequest) Lists the registry records within a registry, with optional filtering by name, status, and record type
- Parameters:
listRegistryRecordsRequest-- Returns:
- A Java Future containing the result of the ListRegistryRecords 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistryRecords
default CompletableFuture<ListRegistryRecordsResponse> listRegistryRecords(Consumer<ListRegistryRecordsRequest.Builder> listRegistryRecordsRequest) Lists the registry records within a registry, with optional filtering by name, status, and record type
This is a convenience which creates an instance of the
ListRegistryRecordsRequest.Builderavoiding the need to create one manually viaListRegistryRecordsRequest.builder()- Parameters:
listRegistryRecordsRequest- AConsumerthat will call methods onListRegistryRecordsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListRegistryRecords 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistryRecordsPaginator
default ListRegistryRecordsPublisher listRegistryRecordsPaginator(ListRegistryRecordsRequest listRegistryRecordsRequest) This is a variant of
listRegistryRecords(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistryRecordsPublisher publisher = client.listRegistryRecordsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistryRecordsPublisher publisher = client.listRegistryRecordsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsResponse 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
listRegistryRecords(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsRequest)operation.- Parameters:
listRegistryRecordsRequest-- 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listRegistryRecordsPaginator
default ListRegistryRecordsPublisher listRegistryRecordsPaginator(Consumer<ListRegistryRecordsRequest.Builder> listRegistryRecordsRequest) This is a variant of
listRegistryRecords(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistryRecordsPublisher publisher = client.listRegistryRecordsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistryRecordsPublisher publisher = client.listRegistryRecordsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsResponse 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
listRegistryRecords(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsRequest)operation.
This is a convenience which creates an instance of the
ListRegistryRecordsRequest.Builderavoiding the need to create one manually viaListRegistryRecordsRequest.builder()- Parameters:
listRegistryRecordsRequest- AConsumerthat will call methods onListRegistryRecordsRequest.Builderto 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List the tags on a resource
- 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ResourceNotFoundException The requested resource was not found.
- ValidationException The request failed validation of one or more input fields.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags on a resource
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ResourceNotFoundException The requested resource was not found.
- ValidationException The request failed validation of one or more input fields.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
submitRegistryRecordForApproval
default CompletableFuture<SubmitRegistryRecordForApprovalResponse> submitRegistryRecordForApproval(SubmitRegistryRecordForApprovalRequest submitRegistryRecordForApprovalRequest) Submits a DRAFT registry record for approval, moving it into the registry's approval workflow. Depending on the registry's approval configuration, the record is either auto-approved or set to PENDING_APPROVAL for a curator to approve or reject.
- Parameters:
submitRegistryRecordForApprovalRequest-- Returns:
- A Java Future containing the result of the SubmitRegistryRecordForApproval 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
submitRegistryRecordForApproval
default CompletableFuture<SubmitRegistryRecordForApprovalResponse> submitRegistryRecordForApproval(Consumer<SubmitRegistryRecordForApprovalRequest.Builder> submitRegistryRecordForApprovalRequest) Submits a DRAFT registry record for approval, moving it into the registry's approval workflow. Depending on the registry's approval configuration, the record is either auto-approved or set to PENDING_APPROVAL for a curator to approve or reject.
This is a convenience which creates an instance of the
SubmitRegistryRecordForApprovalRequest.Builderavoiding the need to create one manually viaSubmitRegistryRecordForApprovalRequest.builder()- Parameters:
submitRegistryRecordForApprovalRequest- AConsumerthat will call methods onSubmitRegistryRecordForApprovalRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SubmitRegistryRecordForApproval 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Tag a resource with key-value pairs
- 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ResourceNotFoundException The requested resource was not found.
- ValidationException The request failed validation of one or more input fields.
- ServiceQuotaExceededException The request would exceed a service quota.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tag a resource with key-value pairs
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ResourceNotFoundException The requested resource was not found.
- ValidationException The request failed validation of one or more input fields.
- ServiceQuotaExceededException The request would exceed a service quota.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Remove tags from a resource by key
- 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ResourceNotFoundException The requested resource was not found.
- ValidationException The request failed validation of one or more input fields.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove tags from a resource by key
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ResourceNotFoundException The requested resource was not found.
- ValidationException The request failed validation of one or more input fields.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRegistry
default CompletableFuture<UpdateRegistryResponse> updateRegistry(UpdateRegistryRequest updateRegistryRequest) Updates an existing registry. This operation uses PATCH semantics: specify only the fields you want to change, and omit the rest to leave them unchanged. Updates are applied asynchronously and the registry transitions to the UPDATING status while they are processed.
- Parameters:
updateRegistryRequest- Request structure for updating a registry- Returns:
- A Java Future containing the result of the UpdateRegistry 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ServiceQuotaExceededException The request would exceed a service quota.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRegistry
default CompletableFuture<UpdateRegistryResponse> updateRegistry(Consumer<UpdateRegistryRequest.Builder> updateRegistryRequest) Updates an existing registry. This operation uses PATCH semantics: specify only the fields you want to change, and omit the rest to leave them unchanged. Updates are applied asynchronously and the registry transitions to the UPDATING status while they are processed.
This is a convenience which creates an instance of the
UpdateRegistryRequest.Builderavoiding the need to create one manually viaUpdateRegistryRequest.builder()- Parameters:
updateRegistryRequest- AConsumerthat will call methods onUpdateRegistryRequest.Builderto create a request. Request structure for updating a registry- Returns:
- A Java Future containing the result of the UpdateRegistry 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ServiceQuotaExceededException The request would exceed a service quota.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRegistryRecord
default CompletableFuture<UpdateRegistryRecordResponse> updateRegistryRecord(UpdateRegistryRecordRequest updateRegistryRecordRequest) Updates a registry record. The update is asynchronous: the record is returned with the UPDATING status while it is processed. Fields that use update wrappers follow PATCH semantics: omit the field to leave it unchanged.
- Parameters:
updateRegistryRecordRequest-- Returns:
- A Java Future containing the result of the UpdateRegistryRecord 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRegistryRecord
default CompletableFuture<UpdateRegistryRecordResponse> updateRegistryRecord(Consumer<UpdateRegistryRecordRequest.Builder> updateRegistryRecordRequest) Updates a registry record. The update is asynchronous: the record is returned with the UPDATING status while it is processed. Fields that use update wrappers follow PATCH semantics: omit the field to leave it unchanged.
This is a convenience which creates an instance of the
UpdateRegistryRecordRequest.Builderavoiding the need to create one manually viaUpdateRegistryRecordRequest.builder()- Parameters:
updateRegistryRecordRequest- AConsumerthat will call methods onUpdateRegistryRecordRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateRegistryRecord 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRegistryRecordStatus
default CompletableFuture<UpdateRegistryRecordStatusResponse> updateRegistryRecordStatus(UpdateRegistryRecordStatusRequest updateRegistryRecordStatusRequest) Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable
- Parameters:
updateRegistryRecordStatusRequest-- Returns:
- A Java Future containing the result of the UpdateRegistryRecordStatus 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateRegistryRecordStatus
default CompletableFuture<UpdateRegistryRecordStatusResponse> updateRegistryRecordStatus(Consumer<UpdateRegistryRecordStatusRequest.Builder> updateRegistryRecordStatusRequest) Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable
This is a convenience which creates an instance of the
UpdateRegistryRecordStatusRequest.Builderavoiding the need to create one manually viaUpdateRegistryRecordStatusRequest.builder()- Parameters:
updateRegistryRecordStatusRequest- AConsumerthat will call methods onUpdateRegistryRecordStatusRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateRegistryRecordStatus 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.- InternalServerException The request failed due to an unexpected internal error; the caller may retry.
- AccessDeniedException The caller is not authorized to perform the requested action.
- ResourceNotFoundException The requested resource was not found.
- ThrottlingException The request was denied due to request throttling; the caller may retry after a delay.
- ValidationException The request failed validation of one or more input fields.
- ConflictException The request conflicts with the current state of the resource.
- 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.
- AgentRegistryControlException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofAgentRegistryControlAsyncWaiterusing this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
AgentRegistryControlAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aAgentRegistryControlAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aAgentRegistryControlAsyncClient.
-