Interface AgentRegistryControlClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing Agent Registry Control. This can be created using the static builder() method.

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

Fields

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

Method Summary

Modifier and Type	Method	Description
static AgentRegistryControlClientBuilder	builder()	Create a builder that can be used to configure and create a AgentRegistryControlClient.
static AgentRegistryControlClient	create()	Create a AgentRegistryControlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default 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 CreateRegistryResponse	createRegistry(CreateRegistryRequest createRegistryRequest)	Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior.
default CreateRegistryRecordResponse	createRegistryRecord(Consumer<CreateRegistryRecordRequest.Builder> createRegistryRecordRequest)	Creates a registry record within a registry.
default CreateRegistryRecordResponse	createRegistryRecord(CreateRegistryRecordRequest createRegistryRecordRequest)	Creates a registry record within a registry.
default DeleteRegistryResponse	deleteRegistry(Consumer<DeleteRegistryRequest.Builder> deleteRegistryRequest)	Deletes a registry.
default DeleteRegistryResponse	deleteRegistry(DeleteRegistryRequest deleteRegistryRequest)	Deletes a registry.
default DeleteRegistryRecordResponse	deleteRegistryRecord(Consumer<DeleteRegistryRecordRequest.Builder> deleteRegistryRecordRequest)	Deletes a registry record
default DeleteRegistryRecordResponse	deleteRegistryRecord(DeleteRegistryRecordRequest deleteRegistryRecordRequest)	Deletes a registry record
default GetRegistryResponse	getRegistry(Consumer<GetRegistryRequest.Builder> getRegistryRequest)	Gets a registry by identifier (ARN or ID)
default GetRegistryResponse	getRegistry(GetRegistryRequest getRegistryRequest)	Gets a registry by identifier (ARN or ID)
default GetRegistryRecordResponse	getRegistryRecord(Consumer<GetRegistryRecordRequest.Builder> getRegistryRecordRequest)	Retrieves the details of a registry record
default GetRegistryRecordResponse	getRegistryRecord(GetRegistryRecordRequest getRegistryRecordRequest)	Retrieves the details of a registry record
default 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
default ListRegistriesResponse	listRegistries(ListRegistriesRequest listRegistriesRequest)	Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer type
default ListRegistriesIterable	listRegistriesPaginator(Consumer<ListRegistriesRequest.Builder> listRegistriesRequest)	This is a variant of listRegistries(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesRequest) operation.
default ListRegistriesIterable	listRegistriesPaginator(ListRegistriesRequest listRegistriesRequest)	This is a variant of listRegistries(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesRequest) operation.
default ListRegistryRecordsResponse	listRegistryRecords(Consumer<ListRegistryRecordsRequest.Builder> listRegistryRecordsRequest)	Lists the registry records within a registry, with optional filtering by name, status, and record type
default ListRegistryRecordsResponse	listRegistryRecords(ListRegistryRecordsRequest listRegistryRecordsRequest)	Lists the registry records within a registry, with optional filtering by name, status, and record type
default ListRegistryRecordsIterable	listRegistryRecordsPaginator(Consumer<ListRegistryRecordsRequest.Builder> listRegistryRecordsRequest)	This is a variant of listRegistryRecords(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsRequest) operation.
default ListRegistryRecordsIterable	listRegistryRecordsPaginator(ListRegistryRecordsRequest listRegistryRecordsRequest)	This is a variant of listRegistryRecords(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	List the tags on a resource
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	List the tags on a resource
default AgentRegistryControlServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default SubmitRegistryRecordForApprovalResponse	submitRegistryRecordForApproval(Consumer<SubmitRegistryRecordForApprovalRequest.Builder> submitRegistryRecordForApprovalRequest)	Submits a DRAFT registry record for approval, moving it into the registry's approval workflow.
default SubmitRegistryRecordForApprovalResponse	submitRegistryRecordForApproval(SubmitRegistryRecordForApprovalRequest submitRegistryRecordForApprovalRequest)	Submits a DRAFT registry record for approval, moving it into the registry's approval workflow.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Tag a resource with key-value pairs
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Tag a resource with key-value pairs
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Remove tags from a resource by key
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Remove tags from a resource by key
default UpdateRegistryResponse	updateRegistry(Consumer<UpdateRegistryRequest.Builder> updateRegistryRequest)	Updates an existing registry.
default UpdateRegistryResponse	updateRegistry(UpdateRegistryRequest updateRegistryRequest)	Updates an existing registry.
default UpdateRegistryRecordResponse	updateRegistryRecord(Consumer<UpdateRegistryRecordRequest.Builder> updateRegistryRecordRequest)	Updates a registry record.
default UpdateRegistryRecordResponse	updateRegistryRecord(UpdateRegistryRecordRequest updateRegistryRecordRequest)	Updates a registry record.
default 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
default 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
default AgentRegistryControlWaiter	waiter()	Create an instance of AgentRegistryControlWaiter using this client.

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

close

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

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

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

See Also:

• Constant Field Values

Method Details

createRegistry

default CreateRegistryResponse createRegistry(CreateRegistryRequest createRegistryRequest)
                                       throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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:

Result of the CreateRegistry operation returned by the service.

See Also:

• AWS API Documentation

createRegistry

default CreateRegistryResponse createRegistry(Consumer<CreateRegistryRequest.Builder> createRegistryRequest)
                                       throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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.Builder avoiding the need to create one manually via CreateRegistryRequest.builder()

Parameters:

createRegistryRequest - A Consumer that will call methods on CreateRegistryRequest.Builder to create a request. Request structure for creating a registry

Returns:

Result of the CreateRegistry operation returned by the service.

See Also:

• AWS API Documentation

createRegistryRecord

default CreateRegistryRecordResponse createRegistryRecord(CreateRegistryRecordRequest createRegistryRecordRequest)
                                                   throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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:

Result of the CreateRegistryRecord operation returned by the service.

See Also:

• AWS API Documentation

createRegistryRecord

default CreateRegistryRecordResponse createRegistryRecord(Consumer<CreateRegistryRecordRequest.Builder> createRegistryRecordRequest)
                                                   throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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.Builder avoiding the need to create one manually via CreateRegistryRecordRequest.builder()

Parameters:

createRegistryRecordRequest - A Consumer that will call methods on CreateRegistryRecordRequest.Builder to create a request.

Returns:

Result of the CreateRegistryRecord operation returned by the service.

See Also:

• AWS API Documentation

deleteRegistry

default DeleteRegistryResponse deleteRegistry(DeleteRegistryRequest deleteRegistryRequest)
                                       throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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:

Result of the DeleteRegistry operation returned by the service.

See Also:

• AWS API Documentation

deleteRegistry

default DeleteRegistryResponse deleteRegistry(Consumer<DeleteRegistryRequest.Builder> deleteRegistryRequest)
                                       throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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.Builder avoiding the need to create one manually via DeleteRegistryRequest.builder()

Parameters:

deleteRegistryRequest - A Consumer that will call methods on DeleteRegistryRequest.Builder to create a request. Request structure for deleting a registry

Returns:

Result of the DeleteRegistry operation returned by the service.

See Also:

• AWS API Documentation

deleteRegistryRecord

default DeleteRegistryRecordResponse deleteRegistryRecord(DeleteRegistryRecordRequest deleteRegistryRecordRequest)
                                                   throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

Deletes a registry record

Parameters:

deleteRegistryRecordRequest -

Returns:

Result of the DeleteRegistryRecord operation returned by the service.

See Also:

• AWS API Documentation

deleteRegistryRecord

default DeleteRegistryRecordResponse deleteRegistryRecord(Consumer<DeleteRegistryRecordRequest.Builder> deleteRegistryRecordRequest)
                                                   throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

Deletes a registry record

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

Parameters:

deleteRegistryRecordRequest - A Consumer that will call methods on DeleteRegistryRecordRequest.Builder to create a request.

Returns:

Result of the DeleteRegistryRecord operation returned by the service.

See Also:

• AWS API Documentation

getRegistry

default GetRegistryResponse getRegistry(GetRegistryRequest getRegistryRequest)
                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

Gets a registry by identifier (ARN or ID)

Parameters:

getRegistryRequest - Request structure for getting a registry

Returns:

Result of the GetRegistry operation returned by the service.

See Also:

• AWS API Documentation

getRegistry

default GetRegistryResponse getRegistry(Consumer<GetRegistryRequest.Builder> getRegistryRequest)
                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

Gets a registry by identifier (ARN or ID)

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

Parameters:

getRegistryRequest - A Consumer that will call methods on GetRegistryRequest.Builder to create a request. Request structure for getting a registry

Returns:

Result of the GetRegistry operation returned by the service.

See Also:

• AWS API Documentation

getRegistryRecord

default GetRegistryRecordResponse getRegistryRecord(GetRegistryRecordRequest getRegistryRecordRequest)
                                             throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

Retrieves the details of a registry record

Parameters:

getRegistryRecordRequest -

Returns:

Result of the GetRegistryRecord operation returned by the service.

See Also:

• AWS API Documentation

getRegistryRecord

default GetRegistryRecordResponse getRegistryRecord(Consumer<GetRegistryRecordRequest.Builder> getRegistryRecordRequest)
                                             throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

Retrieves the details of a registry record

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

Parameters:

getRegistryRecordRequest - A Consumer that will call methods on GetRegistryRecordRequest.Builder to create a request.

Returns:

Result of the GetRegistryRecord operation returned by the service.

See Also:

• AWS API Documentation

listRegistries

default ListRegistriesResponse listRegistries(ListRegistriesRequest listRegistriesRequest)
                                       throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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:

Result of the ListRegistries operation returned by the service.

See Also:

• AWS API Documentation

listRegistries

default ListRegistriesResponse listRegistries(Consumer<ListRegistriesRequest.Builder> listRegistriesRequest)
                                       throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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.Builder avoiding the need to create one manually via ListRegistriesRequest.builder()

Parameters:

listRegistriesRequest - A Consumer that will call methods on ListRegistriesRequest.Builder to create a request. Request structure for listing registries

Returns:

Result of the ListRegistries operation returned by the service.

See Also:

• AWS API Documentation

listRegistriesPaginator

default ListRegistriesIterable listRegistriesPaginator(ListRegistriesRequest listRegistriesRequest)
                                                throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistriesIterable responses = client.listRegistriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistriesIterable responses = client
             .listRegistriesPaginator(request);
     for (software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistriesIterable responses = client.listRegistriesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listRegistries(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesRequest) operation.

Parameters:

listRegistriesRequest - Request structure for listing registries

Returns:

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

See Also:

• AWS API Documentation

listRegistriesPaginator

default ListRegistriesIterable listRegistriesPaginator(Consumer<ListRegistriesRequest.Builder> listRegistriesRequest)
                                                throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistriesIterable responses = client.listRegistriesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistriesIterable responses = client
             .listRegistriesPaginator(request);
     for (software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistriesIterable responses = client.listRegistriesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listRegistries(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistriesRequest) operation.

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

Parameters:

listRegistriesRequest - A Consumer that will call methods on ListRegistriesRequest.Builder to create a request. Request structure for listing registries

Returns:

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

See Also:

• AWS API Documentation

listRegistryRecords

default ListRegistryRecordsResponse listRegistryRecords(ListRegistryRecordsRequest listRegistryRecordsRequest)
                                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

Lists the registry records within a registry, with optional filtering by name, status, and record type

Parameters:

listRegistryRecordsRequest -

Returns:

Result of the ListRegistryRecords operation returned by the service.

See Also:

• AWS API Documentation

listRegistryRecords

default ListRegistryRecordsResponse listRegistryRecords(Consumer<ListRegistryRecordsRequest.Builder> listRegistryRecordsRequest)
                                                 throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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.Builder avoiding the need to create one manually via ListRegistryRecordsRequest.builder()

Parameters:

listRegistryRecordsRequest - A Consumer that will call methods on ListRegistryRecordsRequest.Builder to create a request.

Returns:

Result of the ListRegistryRecords operation returned by the service.

See Also:

• AWS API Documentation

listRegistryRecordsPaginator

default ListRegistryRecordsIterable listRegistryRecordsPaginator(ListRegistryRecordsRequest listRegistryRecordsRequest)
                                                          throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistryRecordsIterable responses = client.listRegistryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistryRecordsIterable responses = client
             .listRegistryRecordsPaginator(request);
     for (software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistryRecordsIterable responses = client.listRegistryRecordsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listRegistryRecords(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsRequest) operation.

Parameters:

listRegistryRecordsRequest -

Returns:

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

See Also:

• AWS API Documentation

listRegistryRecordsPaginator

default ListRegistryRecordsIterable listRegistryRecordsPaginator(Consumer<ListRegistryRecordsRequest.Builder> listRegistryRecordsRequest)
                                                          throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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

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

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

1) Using a Stream

 
 software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistryRecordsIterable responses = client.listRegistryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistryRecordsIterable responses = client
             .listRegistryRecordsPaginator(request);
     for (software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.agentregistrycontrol.paginators.ListRegistryRecordsIterable responses = client.listRegistryRecordsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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

Note: If you prefer to have control on service calls, use the listRegistryRecords(software.amazon.awssdk.services.agentregistrycontrol.model.ListRegistryRecordsRequest) operation.

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

Parameters:

listRegistryRecordsRequest - A Consumer that will call methods on ListRegistryRecordsRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

List the tags on a resource

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

List the tags on a resource

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

submitRegistryRecordForApproval

default SubmitRegistryRecordForApprovalResponse submitRegistryRecordForApproval(SubmitRegistryRecordForApprovalRequest submitRegistryRecordForApprovalRequest)
                                                                         throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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:

Result of the SubmitRegistryRecordForApproval operation returned by the service.

See Also:

• AWS API Documentation

submitRegistryRecordForApproval

default SubmitRegistryRecordForApprovalResponse submitRegistryRecordForApproval(Consumer<SubmitRegistryRecordForApprovalRequest.Builder> submitRegistryRecordForApprovalRequest)
                                                                         throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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.Builder avoiding the need to create one manually via SubmitRegistryRecordForApprovalRequest.builder()

Parameters:

submitRegistryRecordForApprovalRequest - A Consumer that will call methods on SubmitRegistryRecordForApprovalRequest.Builder to create a request.

Returns:

Result of the SubmitRegistryRecordForApproval operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

Tag a resource with key-value pairs

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

Tag a resource with key-value pairs

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

Remove tags from a resource by key

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalServerException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

Remove tags from a resource by key

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateRegistry

default UpdateRegistryResponse updateRegistry(UpdateRegistryRequest updateRegistryRequest)
                                       throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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:

Result of the UpdateRegistry operation returned by the service.

See Also:

• AWS API Documentation

updateRegistry

default UpdateRegistryResponse updateRegistry(Consumer<UpdateRegistryRequest.Builder> updateRegistryRequest)
                                       throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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.Builder avoiding the need to create one manually via UpdateRegistryRequest.builder()

Parameters:

updateRegistryRequest - A Consumer that will call methods on UpdateRegistryRequest.Builder to create a request. Request structure for updating a registry

Returns:

Result of the UpdateRegistry operation returned by the service.

See Also:

• AWS API Documentation

updateRegistryRecord

default UpdateRegistryRecordResponse updateRegistryRecord(UpdateRegistryRecordRequest updateRegistryRecordRequest)
                                                   throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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:

Result of the UpdateRegistryRecord operation returned by the service.

See Also:

• AWS API Documentation

updateRegistryRecord

default UpdateRegistryRecordResponse updateRegistryRecord(Consumer<UpdateRegistryRecordRequest.Builder> updateRegistryRecordRequest)
                                                   throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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.Builder avoiding the need to create one manually via UpdateRegistryRecordRequest.builder()

Parameters:

updateRegistryRecordRequest - A Consumer that will call methods on UpdateRegistryRecordRequest.Builder to create a request.

Returns:

Result of the UpdateRegistryRecord operation returned by the service.

See Also:

• AWS API Documentation

updateRegistryRecordStatus

default UpdateRegistryRecordStatusResponse updateRegistryRecordStatus(UpdateRegistryRecordStatusRequest updateRegistryRecordStatusRequest)
                                                               throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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:

Result of the UpdateRegistryRecordStatus operation returned by the service.

See Also:

• AWS API Documentation

updateRegistryRecordStatus

default UpdateRegistryRecordStatusResponse updateRegistryRecordStatus(Consumer<UpdateRegistryRecordStatusRequest.Builder> updateRegistryRecordStatusRequest)
                                                               throws InternalServerException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
AgentRegistryControlException

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.Builder avoiding the need to create one manually via UpdateRegistryRecordStatusRequest.builder()

Parameters:

updateRegistryRecordStatusRequest - A Consumer that will call methods on UpdateRegistryRecordStatusRequest.Builder to create a request.

Returns:

Result of the UpdateRegistryRecordStatus operation returned by the service.

See Also:

• AWS API Documentation

waiter

default AgentRegistryControlWaiter waiter()

Create an instance of AgentRegistryControlWaiter using 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 AgentRegistryControlWaiter

create

static AgentRegistryControlClient create()

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

builder

static AgentRegistryControlClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default AgentRegistryControlServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

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

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration