@Generated(value="software.amazon.awssdk:codegen") public interface ServiceDiscoveryClient extends SdkClient
builder() method.
AWS Cloud Map lets you configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance of the service becomes available, you can call the AWS Cloud Map API to register the instance with AWS Cloud Map. For public or private DNS namespaces, AWS Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static ServiceDiscoveryClientBuilder |
builder()
Create a builder that can be used to configure and create a
ServiceDiscoveryClient. |
static ServiceDiscoveryClient |
create()
Create a
ServiceDiscoveryClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateHttpNamespaceResponse |
createHttpNamespace(Consumer<CreateHttpNamespaceRequest.Builder> createHttpNamespaceRequest)
Creates an HTTP namespace.
|
default CreateHttpNamespaceResponse |
createHttpNamespace(CreateHttpNamespaceRequest createHttpNamespaceRequest)
Creates an HTTP namespace.
|
default CreatePrivateDnsNamespaceResponse |
createPrivateDnsNamespace(Consumer<CreatePrivateDnsNamespaceRequest.Builder> createPrivateDnsNamespaceRequest)
Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC.
|
default CreatePrivateDnsNamespaceResponse |
createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest createPrivateDnsNamespaceRequest)
Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC.
|
default CreatePublicDnsNamespaceResponse |
createPublicDnsNamespace(Consumer<CreatePublicDnsNamespaceRequest.Builder> createPublicDnsNamespaceRequest)
Creates a public namespace based on DNS, which will be visible on the internet.
|
default CreatePublicDnsNamespaceResponse |
createPublicDnsNamespace(CreatePublicDnsNamespaceRequest createPublicDnsNamespaceRequest)
Creates a public namespace based on DNS, which will be visible on the internet.
|
default CreateServiceResponse |
createService(Consumer<CreateServiceRequest.Builder> createServiceRequest)
Creates a service, which defines the configuration for the following entities:
|
default CreateServiceResponse |
createService(CreateServiceRequest createServiceRequest)
Creates a service, which defines the configuration for the following entities:
|
default DeleteNamespaceResponse |
deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest)
Deletes a namespace from the current account.
|
default DeleteNamespaceResponse |
deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)
Deletes a namespace from the current account.
|
default DeleteServiceResponse |
deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest)
Deletes a specified service.
|
default DeleteServiceResponse |
deleteService(DeleteServiceRequest deleteServiceRequest)
Deletes a specified service.
|
default DeregisterInstanceResponse |
deregisterInstance(Consumer<DeregisterInstanceRequest.Builder> deregisterInstanceRequest)
Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified
instance.
|
default DeregisterInstanceResponse |
deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)
Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified
instance.
|
default DiscoverInstancesResponse |
discoverInstances(Consumer<DiscoverInstancesRequest.Builder> discoverInstancesRequest)
Discovers registered instances for a specified namespace and service.
|
default DiscoverInstancesResponse |
discoverInstances(DiscoverInstancesRequest discoverInstancesRequest)
Discovers registered instances for a specified namespace and service.
|
default GetInstanceResponse |
getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest)
Gets information about a specified instance.
|
default GetInstanceResponse |
getInstance(GetInstanceRequest getInstanceRequest)
Gets information about a specified instance.
|
default GetInstancesHealthStatusResponse |
getInstancesHealthStatus(Consumer<GetInstancesHealthStatusRequest.Builder> getInstancesHealthStatusRequest)
Gets the current health status (
Healthy, Unhealthy, or Unknown) of one or
more instances that are associated with a specified service. |
default GetInstancesHealthStatusResponse |
getInstancesHealthStatus(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest)
Gets the current health status (
Healthy, Unhealthy, or Unknown) of one or
more instances that are associated with a specified service. |
default GetInstancesHealthStatusIterable |
getInstancesHealthStatusPaginator(Consumer<GetInstancesHealthStatusRequest.Builder> getInstancesHealthStatusRequest)
Gets the current health status (
Healthy, Unhealthy, or Unknown) of one or
more instances that are associated with a specified service. |
default GetInstancesHealthStatusIterable |
getInstancesHealthStatusPaginator(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest)
Gets the current health status (
Healthy, Unhealthy, or Unknown) of one or
more instances that are associated with a specified service. |
default GetNamespaceResponse |
getNamespace(Consumer<GetNamespaceRequest.Builder> getNamespaceRequest)
Gets information about a namespace.
|
default GetNamespaceResponse |
getNamespace(GetNamespaceRequest getNamespaceRequest)
Gets information about a namespace.
|
default GetOperationResponse |
getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest)
Gets information about any operation that returns an operation ID in the response, such as a
CreateService request. |
default GetOperationResponse |
getOperation(GetOperationRequest getOperationRequest)
Gets information about any operation that returns an operation ID in the response, such as a
CreateService request. |
default GetServiceResponse |
getService(Consumer<GetServiceRequest.Builder> getServiceRequest)
Gets the settings for a specified service.
|
default GetServiceResponse |
getService(GetServiceRequest getServiceRequest)
Gets the settings for a specified service.
|
default ListInstancesResponse |
listInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest)
Lists summary information about the instances that you registered by using a specified service.
|
default ListInstancesResponse |
listInstances(ListInstancesRequest listInstancesRequest)
Lists summary information about the instances that you registered by using a specified service.
|
default ListInstancesIterable |
listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest)
Lists summary information about the instances that you registered by using a specified service.
|
default ListInstancesIterable |
listInstancesPaginator(ListInstancesRequest listInstancesRequest)
Lists summary information about the instances that you registered by using a specified service.
|
default ListNamespacesResponse |
listNamespaces()
Lists summary information about the namespaces that were created by the current AWS account.
|
default ListNamespacesResponse |
listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)
Lists summary information about the namespaces that were created by the current AWS account.
|
default ListNamespacesResponse |
listNamespaces(ListNamespacesRequest listNamespacesRequest)
Lists summary information about the namespaces that were created by the current AWS account.
|
default ListNamespacesIterable |
listNamespacesPaginator()
Lists summary information about the namespaces that were created by the current AWS account.
|
default ListNamespacesIterable |
listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)
Lists summary information about the namespaces that were created by the current AWS account.
|
default ListNamespacesIterable |
listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest)
Lists summary information about the namespaces that were created by the current AWS account.
|
default ListOperationsResponse |
listOperations()
Lists operations that match the criteria that you specify.
|
default ListOperationsResponse |
listOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest)
Lists operations that match the criteria that you specify.
|
default ListOperationsResponse |
listOperations(ListOperationsRequest listOperationsRequest)
Lists operations that match the criteria that you specify.
|
default ListOperationsIterable |
listOperationsPaginator()
Lists operations that match the criteria that you specify.
|
default ListOperationsIterable |
listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest)
Lists operations that match the criteria that you specify.
|
default ListOperationsIterable |
listOperationsPaginator(ListOperationsRequest listOperationsRequest)
Lists operations that match the criteria that you specify.
|
default ListServicesResponse |
listServices()
Lists summary information for all the services that are associated with one or more specified namespaces.
|
default ListServicesResponse |
listServices(Consumer<ListServicesRequest.Builder> listServicesRequest)
Lists summary information for all the services that are associated with one or more specified namespaces.
|
default ListServicesResponse |
listServices(ListServicesRequest listServicesRequest)
Lists summary information for all the services that are associated with one or more specified namespaces.
|
default ListServicesIterable |
listServicesPaginator()
Lists summary information for all the services that are associated with one or more specified namespaces.
|
default ListServicesIterable |
listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest)
Lists summary information for all the services that are associated with one or more specified namespaces.
|
default ListServicesIterable |
listServicesPaginator(ListServicesRequest listServicesRequest)
Lists summary information for all the services that are associated with one or more specified namespaces.
|
default RegisterInstanceResponse |
registerInstance(Consumer<RegisterInstanceRequest.Builder> registerInstanceRequest)
Creates or updates one or more records and, optionally, creates a health check based on the settings in a
specified service.
|
default RegisterInstanceResponse |
registerInstance(RegisterInstanceRequest registerInstanceRequest)
Creates or updates one or more records and, optionally, creates a health check based on the settings in a
specified service.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateInstanceCustomHealthStatusResponse |
updateInstanceCustomHealthStatus(Consumer<UpdateInstanceCustomHealthStatusRequest.Builder> updateInstanceCustomHealthStatusRequest)
Submits a request to change the health status of a custom health check to healthy or unhealthy.
|
default UpdateInstanceCustomHealthStatusResponse |
updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest updateInstanceCustomHealthStatusRequest)
Submits a request to change the health status of a custom health check to healthy or unhealthy.
|
default UpdateServiceResponse |
updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest)
Submits a request to perform the following operations:
|
default UpdateServiceResponse |
updateService(UpdateServiceRequest updateServiceRequest)
Submits a request to perform the following operations:
|
serviceNameclosestatic final String SERVICE_NAME
static ServiceDiscoveryClient create()
ServiceDiscoveryClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ServiceDiscoveryClientBuilder builder()
ServiceDiscoveryClient.default CreateHttpNamespaceResponse createHttpNamespace(CreateHttpNamespaceRequest createHttpNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a
DiscoverInstances request but can't be discovered using DNS.
For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
createHttpNamespaceRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.DuplicateRequestException - The operation is already in progress.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateHttpNamespaceResponse createHttpNamespace(Consumer<CreateHttpNamespaceRequest.Builder> createHttpNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a
DiscoverInstances request but can't be discovered using DNS.
For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
This is a convenience which creates an instance of the CreateHttpNamespaceRequest.Builder avoiding the
need to create one manually via CreateHttpNamespaceRequest.builder()
createHttpNamespaceRequest - A Consumer that will call methods on CreateHttpNamespaceRequest.Builder to create a
request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.DuplicateRequestException - The operation is already in progress.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePrivateDnsNamespaceResponse createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest createPrivateDnsNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace
defines your service naming scheme. For example, if you name your namespace example.com and name
your service backend, the resulting DNS name for the service will be
backend.example.com. For the current limit on the number of namespaces that you can create using the
same AWS account, see AWS Cloud
Map Limits in the AWS Cloud Map Developer Guide.
createPrivateDnsNamespaceRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.DuplicateRequestException - The operation is already in progress.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePrivateDnsNamespaceResponse createPrivateDnsNamespace(Consumer<CreatePrivateDnsNamespaceRequest.Builder> createPrivateDnsNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace
defines your service naming scheme. For example, if you name your namespace example.com and name
your service backend, the resulting DNS name for the service will be
backend.example.com. For the current limit on the number of namespaces that you can create using the
same AWS account, see AWS Cloud
Map Limits in the AWS Cloud Map Developer Guide.
This is a convenience which creates an instance of the CreatePrivateDnsNamespaceRequest.Builder avoiding
the need to create one manually via CreatePrivateDnsNamespaceRequest.builder()
createPrivateDnsNamespaceRequest - A Consumer that will call methods on CreatePrivateDnsNamespaceRequest.Builder to create a
request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.DuplicateRequestException - The operation is already in progress.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePublicDnsNamespaceResponse createPublicDnsNamespace(CreatePublicDnsNamespaceRequest createPublicDnsNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your
service naming scheme. For example, if you name your namespace example.com and name your service
backend, the resulting DNS name for the service will be backend.example.com. For the
current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the
AWS Cloud Map Developer Guide.
createPublicDnsNamespaceRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.DuplicateRequestException - The operation is already in progress.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePublicDnsNamespaceResponse createPublicDnsNamespace(Consumer<CreatePublicDnsNamespaceRequest.Builder> createPublicDnsNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your
service naming scheme. For example, if you name your namespace example.com and name your service
backend, the resulting DNS name for the service will be backend.example.com. For the
current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the
AWS Cloud Map Developer Guide.
This is a convenience which creates an instance of the CreatePublicDnsNamespaceRequest.Builder avoiding
the need to create one manually via CreatePublicDnsNamespaceRequest.builder()
createPublicDnsNamespaceRequest - A Consumer that will call methods on CreatePublicDnsNamespaceRequest.Builder to create a
request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.DuplicateRequestException - The operation is already in progress.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateServiceResponse createService(CreateServiceRequest createServiceRequest) throws InvalidInputException, ResourceLimitExceededException, NamespaceNotFoundException, ServiceAlreadyExistsException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a service, which defines the configuration for the following entities:
For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:
A
AAAA
A and AAAA
SRV
CNAME
Optionally, a health check
After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities.
For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
createServiceRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.NamespaceNotFoundException - No namespace exists with the specified ID.ServiceAlreadyExistsException - The service can't be created because a service with the same name already exists.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateServiceResponse createService(Consumer<CreateServiceRequest.Builder> createServiceRequest) throws InvalidInputException, ResourceLimitExceededException, NamespaceNotFoundException, ServiceAlreadyExistsException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a service, which defines the configuration for the following entities:
For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:
A
AAAA
A and AAAA
SRV
CNAME
Optionally, a health check
After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities.
For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
This is a convenience which creates an instance of the CreateServiceRequest.Builder avoiding the need to
create one manually via CreateServiceRequest.builder()
createServiceRequest - A Consumer that will call methods on CreateServiceRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.NamespaceNotFoundException - No namespace exists with the specified ID.ServiceAlreadyExistsException - The service can't be created because a service with the same name already exists.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteNamespaceResponse deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest) throws InvalidInputException, NamespaceNotFoundException, ResourceInUseException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
deleteNamespaceRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.NamespaceNotFoundException - No namespace exists with the specified ID.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.DuplicateRequestException - The operation is already in progress.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteNamespaceResponse deleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest) throws InvalidInputException, NamespaceNotFoundException, ResourceInUseException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.
This is a convenience which creates an instance of the DeleteNamespaceRequest.Builder avoiding the need
to create one manually via DeleteNamespaceRequest.builder()
deleteNamespaceRequest - A Consumer that will call methods on DeleteNamespaceRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.NamespaceNotFoundException - No namespace exists with the specified ID.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.DuplicateRequestException - The operation is already in progress.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteServiceResponse deleteService(DeleteServiceRequest deleteServiceRequest) throws InvalidInputException, ServiceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Deletes a specified service. If the service still contains one or more registered instances, the request fails.
deleteServiceRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteServiceResponse deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest) throws InvalidInputException, ServiceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Deletes a specified service. If the service still contains one or more registered instances, the request fails.
This is a convenience which creates an instance of the DeleteServiceRequest.Builder avoiding the need to
create one manually via DeleteServiceRequest.builder()
deleteServiceRequest - A Consumer that will call methods on DeleteServiceRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterInstanceResponse deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest) throws DuplicateRequestException, InvalidInputException, InstanceNotFoundException, ResourceInUseException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.
deregisterInstanceRequest - DuplicateRequestException - The operation is already in progress.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeregisterInstanceResponse deregisterInstance(Consumer<DeregisterInstanceRequest.Builder> deregisterInstanceRequest) throws DuplicateRequestException, InvalidInputException, InstanceNotFoundException, ResourceInUseException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.
This is a convenience which creates an instance of the DeregisterInstanceRequest.Builder avoiding the
need to create one manually via DeregisterInstanceRequest.builder()
deregisterInstanceRequest - A Consumer that will call methods on DeregisterInstanceRequest.Builder to create a
request.DuplicateRequestException - The operation is already in progress.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DiscoverInstancesResponse discoverInstances(DiscoverInstancesRequest discoverInstancesRequest) throws ServiceNotFoundException, NamespaceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Discovers registered instances for a specified namespace and service.
discoverInstancesRequest - ServiceNotFoundException - No service exists with the specified ID.NamespaceNotFoundException - No namespace exists with the specified ID.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DiscoverInstancesResponse discoverInstances(Consumer<DiscoverInstancesRequest.Builder> discoverInstancesRequest) throws ServiceNotFoundException, NamespaceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Discovers registered instances for a specified namespace and service.
This is a convenience which creates an instance of the DiscoverInstancesRequest.Builder avoiding the need
to create one manually via DiscoverInstancesRequest.builder()
discoverInstancesRequest - A Consumer that will call methods on DiscoverInstancesRequest.Builder to create a request.ServiceNotFoundException - No service exists with the specified ID.NamespaceNotFoundException - No namespace exists with the specified ID.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceResponse getInstance(GetInstanceRequest getInstanceRequest) throws InstanceNotFoundException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets information about a specified instance.
getInstanceRequest - InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceResponse getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest) throws InstanceNotFoundException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets information about a specified instance.
This is a convenience which creates an instance of the GetInstanceRequest.Builder avoiding the need to
create one manually via GetInstanceRequest.builder()
getInstanceRequest - A Consumer that will call methods on GetInstanceRequest.Builder to create a request.InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstancesHealthStatusResponse getInstancesHealthStatus(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest) throws InstanceNotFoundException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets the current health status (Healthy, Unhealthy, or Unknown) of one or
more instances that are associated with a specified service.
There is a brief delay between when you register an instance and when the health status for the instance is available.
getInstancesHealthStatusRequest - InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstancesHealthStatusResponse getInstancesHealthStatus(Consumer<GetInstancesHealthStatusRequest.Builder> getInstancesHealthStatusRequest) throws InstanceNotFoundException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets the current health status (Healthy, Unhealthy, or Unknown) of one or
more instances that are associated with a specified service.
There is a brief delay between when you register an instance and when the health status for the instance is available.
This is a convenience which creates an instance of the GetInstancesHealthStatusRequest.Builder avoiding
the need to create one manually via GetInstancesHealthStatusRequest.builder()
getInstancesHealthStatusRequest - A Consumer that will call methods on GetInstancesHealthStatusRequest.Builder to create a
request.InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstancesHealthStatusIterable getInstancesHealthStatusPaginator(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest) throws InstanceNotFoundException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets the current health status (Healthy, Unhealthy, or Unknown) of one or
more instances that are associated with a specified service.
There is a brief delay between when you register an instance and when the health status for the instance is available.
This is a variant of
getInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest)
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.servicediscovery.paginators.GetInstancesHealthStatusIterable responses = client.getInstancesHealthStatusPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusIterable responses = client
.getInstancesHealthStatusPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusIterable responses = client.getInstancesHealthStatusPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest)
operation.
getInstancesHealthStatusRequest - InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstancesHealthStatusIterable getInstancesHealthStatusPaginator(Consumer<GetInstancesHealthStatusRequest.Builder> getInstancesHealthStatusRequest) throws InstanceNotFoundException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets the current health status (Healthy, Unhealthy, or Unknown) of one or
more instances that are associated with a specified service.
There is a brief delay between when you register an instance and when the health status for the instance is available.
This is a variant of
getInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest)
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.servicediscovery.paginators.GetInstancesHealthStatusIterable responses = client.getInstancesHealthStatusPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusIterable responses = client
.getInstancesHealthStatusPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusIterable responses = client.getInstancesHealthStatusPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest)
operation.
This is a convenience which creates an instance of the GetInstancesHealthStatusRequest.Builder avoiding
the need to create one manually via GetInstancesHealthStatusRequest.builder()
getInstancesHealthStatusRequest - A Consumer that will call methods on GetInstancesHealthStatusRequest.Builder to create a
request.InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetNamespaceResponse getNamespace(GetNamespaceRequest getNamespaceRequest) throws InvalidInputException, NamespaceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets information about a namespace.
getNamespaceRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.NamespaceNotFoundException - No namespace exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetNamespaceResponse getNamespace(Consumer<GetNamespaceRequest.Builder> getNamespaceRequest) throws InvalidInputException, NamespaceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets information about a namespace.
This is a convenience which creates an instance of the GetNamespaceRequest.Builder avoiding the need to
create one manually via GetNamespaceRequest.builder()
getNamespaceRequest - A Consumer that will call methods on GetNamespaceRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.NamespaceNotFoundException - No namespace exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetOperationResponse getOperation(GetOperationRequest getOperationRequest) throws InvalidInputException, OperationNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets information about any operation that returns an operation ID in the response, such as a
CreateService request.
To get a list of operations that match specified criteria, see ListOperations.
getOperationRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.OperationNotFoundException - No operation exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetOperationResponse getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest) throws InvalidInputException, OperationNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets information about any operation that returns an operation ID in the response, such as a
CreateService request.
To get a list of operations that match specified criteria, see ListOperations.
This is a convenience which creates an instance of the GetOperationRequest.Builder avoiding the need to
create one manually via GetOperationRequest.builder()
getOperationRequest - A Consumer that will call methods on GetOperationRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.OperationNotFoundException - No operation exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetServiceResponse getService(GetServiceRequest getServiceRequest) throws InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets the settings for a specified service.
getServiceRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetServiceResponse getService(Consumer<GetServiceRequest.Builder> getServiceRequest) throws InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets the settings for a specified service.
This is a convenience which creates an instance of the GetServiceRequest.Builder avoiding the need to
create one manually via GetServiceRequest.builder()
getServiceRequest - A Consumer that will call methods on GetServiceRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstancesResponse listInstances(ListInstancesRequest listInstancesRequest) throws ServiceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the instances that you registered by using a specified service.
listInstancesRequest - ServiceNotFoundException - No service exists with the specified ID.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstancesResponse listInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest) throws ServiceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the instances that you registered by using a specified service.
This is a convenience which creates an instance of the ListInstancesRequest.Builder avoiding the need to
create one manually via ListInstancesRequest.builder()
listInstancesRequest - A Consumer that will call methods on ListInstancesRequest.Builder to create a request.ServiceNotFoundException - No service exists with the specified ID.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstancesIterable listInstancesPaginator(ListInstancesRequest listInstancesRequest) throws ServiceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the instances that you registered by using a specified service.
This is a variant of
listInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest) 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.servicediscovery.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.ListInstancesIterable responses = client
.listInstancesPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.ListInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest)
operation.
listInstancesRequest - ServiceNotFoundException - No service exists with the specified ID.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstancesIterable listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest) throws ServiceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the instances that you registered by using a specified service.
This is a variant of
listInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest) 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.servicediscovery.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.ListInstancesIterable responses = client
.listInstancesPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.ListInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest)
operation.
This is a convenience which creates an instance of the ListInstancesRequest.Builder avoiding the need to
create one manually via ListInstancesRequest.builder()
listInstancesRequest - A Consumer that will call methods on ListInstancesRequest.Builder to create a request.ServiceNotFoundException - No service exists with the specified ID.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListNamespacesResponse listNamespaces() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the namespaces that were created by the current AWS account.
InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistNamespaces(ListNamespacesRequest),
AWS API Documentationdefault ListNamespacesResponse listNamespaces(ListNamespacesRequest listNamespacesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the namespaces that were created by the current AWS account.
listNamespacesRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListNamespacesResponse listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the namespaces that were created by the current AWS account.
This is a convenience which creates an instance of the ListNamespacesRequest.Builder avoiding the need to
create one manually via ListNamespacesRequest.builder()
listNamespacesRequest - A Consumer that will call methods on ListNamespacesRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListNamespacesIterable listNamespacesPaginator() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the namespaces that were created by the current AWS account.
This is a variant of
listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest) 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.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client
.listNamespacesPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.ListNamespacesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest)
operation.
InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistNamespacesPaginator(ListNamespacesRequest),
AWS API Documentationdefault ListNamespacesIterable listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the namespaces that were created by the current AWS account.
This is a variant of
listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest) 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.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client
.listNamespacesPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.ListNamespacesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest)
operation.
listNamespacesRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListNamespacesIterable listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the namespaces that were created by the current AWS account.
This is a variant of
listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest) 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.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client
.listNamespacesPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.ListNamespacesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest)
operation.
This is a convenience which creates an instance of the ListNamespacesRequest.Builder avoiding the need to
create one manually via ListNamespacesRequest.builder()
listNamespacesRequest - A Consumer that will call methods on ListNamespacesRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOperationsResponse listOperations() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists operations that match the criteria that you specify.
InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistOperations(ListOperationsRequest),
AWS API Documentationdefault ListOperationsResponse listOperations(ListOperationsRequest listOperationsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists operations that match the criteria that you specify.
listOperationsRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOperationsResponse listOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists operations that match the criteria that you specify.
This is a convenience which creates an instance of the ListOperationsRequest.Builder avoiding the need to
create one manually via ListOperationsRequest.builder()
listOperationsRequest - A Consumer that will call methods on ListOperationsRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOperationsIterable listOperationsPaginator() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists operations that match the criteria that you specify.
This is a variant of
listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest) 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.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client
.listOperationsPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.ListOperationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest)
operation.
InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistOperationsPaginator(ListOperationsRequest),
AWS API Documentationdefault ListOperationsIterable listOperationsPaginator(ListOperationsRequest listOperationsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists operations that match the criteria that you specify.
This is a variant of
listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest) 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.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client
.listOperationsPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.ListOperationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest)
operation.
listOperationsRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListOperationsIterable listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists operations that match the criteria that you specify.
This is a variant of
listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest) 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.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client
.listOperationsPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.ListOperationsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest)
operation.
This is a convenience which creates an instance of the ListOperationsRequest.Builder avoiding the need to
create one manually via ListOperationsRequest.builder()
listOperationsRequest - A Consumer that will call methods on ListOperationsRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServicesResponse listServices() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information for all the services that are associated with one or more specified namespaces.
InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistServices(ListServicesRequest),
AWS
API Documentationdefault ListServicesResponse listServices(ListServicesRequest listServicesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information for all the services that are associated with one or more specified namespaces.
listServicesRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServicesResponse listServices(Consumer<ListServicesRequest.Builder> listServicesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information for all the services that are associated with one or more specified namespaces.
This is a convenience which creates an instance of the ListServicesRequest.Builder avoiding the need to
create one manually via ListServicesRequest.builder()
listServicesRequest - A Consumer that will call methods on ListServicesRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServicesIterable listServicesPaginator() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information for all the services that are associated with one or more specified namespaces.
This is a variant of
listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) 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.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client
.listServicesPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.ListServicesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) operation.
InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistServicesPaginator(ListServicesRequest),
AWS
API Documentationdefault ListServicesIterable listServicesPaginator(ListServicesRequest listServicesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information for all the services that are associated with one or more specified namespaces.
This is a variant of
listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) 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.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client
.listServicesPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.ListServicesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) operation.
listServicesRequest - InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListServicesIterable listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information for all the services that are associated with one or more specified namespaces.
This is a variant of
listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) 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.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client
.listServicesPaginator(request);
for (software.amazon.awssdk.services.servicediscovery.model.ListServicesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest) operation.
This is a convenience which creates an instance of the ListServicesRequest.Builder avoiding the need to
create one manually via ListServicesRequest.builder()
listServicesRequest - A Consumer that will call methods on ListServicesRequest.Builder to create a request.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterInstanceResponse registerInstance(RegisterInstanceRequest registerInstanceRequest) throws DuplicateRequestException, InvalidInputException, ResourceInUseException, ResourceLimitExceededException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates or updates one or more records and, optionally, creates a health check based on the settings in a
specified service. When you submit a RegisterInstance request, the following occurs:
For each DNS record that you define in the service that is specified by ServiceId, a record is
created or updated in the hosted zone that is associated with the corresponding namespace.
If the service includes HealthCheckConfig, a health check is created based on the settings in the
health check configuration.
The health check, if any, is associated with each of the new or updated records.
One RegisterInstance request must complete before you can submit another request and specify the
same service ID and instance ID.
For more information, see CreateService.
When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
If the health check is healthy: returns all the records
If the health check is unhealthy: returns the applicable value for the last healthy instance
If you didn't specify a health check configuration: returns all the records
For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
registerInstanceRequest - DuplicateRequestException - The operation is already in progress.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterInstanceResponse registerInstance(Consumer<RegisterInstanceRequest.Builder> registerInstanceRequest) throws DuplicateRequestException, InvalidInputException, ResourceInUseException, ResourceLimitExceededException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates or updates one or more records and, optionally, creates a health check based on the settings in a
specified service. When you submit a RegisterInstance request, the following occurs:
For each DNS record that you define in the service that is specified by ServiceId, a record is
created or updated in the hosted zone that is associated with the corresponding namespace.
If the service includes HealthCheckConfig, a health check is created based on the settings in the
health check configuration.
The health check, if any, is associated with each of the new or updated records.
One RegisterInstance request must complete before you can submit another request and specify the
same service ID and instance ID.
For more information, see CreateService.
When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:
If the health check is healthy: returns all the records
If the health check is unhealthy: returns the applicable value for the last healthy instance
If you didn't specify a health check configuration: returns all the records
For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.
This is a convenience which creates an instance of the RegisterInstanceRequest.Builder avoiding the need
to create one manually via RegisterInstanceRequest.builder()
registerInstanceRequest - A Consumer that will call methods on RegisterInstanceRequest.Builder to create a request.DuplicateRequestException - The operation is already in progress.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't
delete a service that contains any instances.ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateInstanceCustomHealthStatusResponse updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest updateInstanceCustomHealthStatusRequest) throws InstanceNotFoundException, ServiceNotFoundException, CustomHealthNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Submits a request to change the health status of a custom health check to healthy or unhealthy.
You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks,
which you define using HealthCheckCustomConfig when you create a service. You can't use it to change
the status for Route 53 health checks, which you define using HealthCheckConfig.
For more information, see HealthCheckCustomConfig.
updateInstanceCustomHealthStatusRequest - InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.ServiceNotFoundException - No service exists with the specified ID.CustomHealthNotFoundException - The health check for the instance that is specified by ServiceId and InstanceId
is not a custom health check.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateInstanceCustomHealthStatusResponse updateInstanceCustomHealthStatus(Consumer<UpdateInstanceCustomHealthStatusRequest.Builder> updateInstanceCustomHealthStatusRequest) throws InstanceNotFoundException, ServiceNotFoundException, CustomHealthNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Submits a request to change the health status of a custom health check to healthy or unhealthy.
You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks,
which you define using HealthCheckCustomConfig when you create a service. You can't use it to change
the status for Route 53 health checks, which you define using HealthCheckConfig.
For more information, see HealthCheckCustomConfig.
This is a convenience which creates an instance of the UpdateInstanceCustomHealthStatusRequest.Builder
avoiding the need to create one manually via UpdateInstanceCustomHealthStatusRequest.builder()
updateInstanceCustomHealthStatusRequest - A Consumer that will call methods on UpdateInstanceCustomHealthStatusRequest.Builder to
create a request.InstanceNotFoundException - No instance exists with the specified ID, or the instance was recently registered, and information about
the instance hasn't propagated yet.ServiceNotFoundException - No service exists with the specified ID.CustomHealthNotFoundException - The health check for the instance that is specified by ServiceId and InstanceId
is not a custom health check.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateServiceResponse updateService(UpdateServiceRequest updateServiceRequest) throws DuplicateRequestException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Submits a request to perform the following operations:
Add or delete DnsRecords configurations
Update the TTL setting for existing DnsRecords configurations
Add, update, or delete HealthCheckConfig for a specified service
For public and private DNS namespaces, you must specify all DnsRecords configurations (and,
optionally, HealthCheckConfig) that you want to appear in the updated service. Any current
configurations that don't appear in an UpdateService request are deleted.
When you update the TTL setting for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.
updateServiceRequest - DuplicateRequestException - The operation is already in progress.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateServiceResponse updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest) throws DuplicateRequestException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Submits a request to perform the following operations:
Add or delete DnsRecords configurations
Update the TTL setting for existing DnsRecords configurations
Add, update, or delete HealthCheckConfig for a specified service
For public and private DNS namespaces, you must specify all DnsRecords configurations (and,
optionally, HealthCheckConfig) that you want to appear in the updated service. Any current
configurations that don't appear in an UpdateService request are deleted.
When you update the TTL setting for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.
This is a convenience which creates an instance of the UpdateServiceRequest.Builder avoiding the need to
create one manually via UpdateServiceRequest.builder()
updateServiceRequest - A Consumer that will call methods on UpdateServiceRequest.Builder to create a request.DuplicateRequestException - The operation is already in progress.InvalidInputException - One or more specified values aren't valid. For example, a required value might be missing, a numeric
value might be outside the allowed range, or a string value might exceed length constraints.ServiceNotFoundException - No service exists with the specified ID.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.ServiceDiscoveryException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.