Interface ServiceDiscoveryClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ServiceDiscoveryClient extends AwsClient
Service client for accessing ServiceDiscovery. This can be created using the staticbuilder()method.Cloud Map With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance becomes available, you can call the Cloud Map API to register the instance with Cloud Map. For public or private DNS namespaces, 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.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static ServiceDiscoveryClientBuilderbuilder()Create a builder that can be used to configure and create aServiceDiscoveryClient.static ServiceDiscoveryClientcreate()Create aServiceDiscoveryClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateHttpNamespaceResponsecreateHttpNamespace(Consumer<CreateHttpNamespaceRequest.Builder> createHttpNamespaceRequest)Creates an HTTP namespace.default CreateHttpNamespaceResponsecreateHttpNamespace(CreateHttpNamespaceRequest createHttpNamespaceRequest)Creates an HTTP namespace.default CreatePrivateDnsNamespaceResponsecreatePrivateDnsNamespace(Consumer<CreatePrivateDnsNamespaceRequest.Builder> createPrivateDnsNamespaceRequest)Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC.default CreatePrivateDnsNamespaceResponsecreatePrivateDnsNamespace(CreatePrivateDnsNamespaceRequest createPrivateDnsNamespaceRequest)Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC.default CreatePublicDnsNamespaceResponsecreatePublicDnsNamespace(Consumer<CreatePublicDnsNamespaceRequest.Builder> createPublicDnsNamespaceRequest)Creates a public namespace based on DNS, which is visible on the internet.default CreatePublicDnsNamespaceResponsecreatePublicDnsNamespace(CreatePublicDnsNamespaceRequest createPublicDnsNamespaceRequest)Creates a public namespace based on DNS, which is visible on the internet.default CreateServiceResponsecreateService(Consumer<CreateServiceRequest.Builder> createServiceRequest)Creates a service.default CreateServiceResponsecreateService(CreateServiceRequest createServiceRequest)Creates a service.default DeleteNamespaceResponsedeleteNamespace(Consumer<DeleteNamespaceRequest.Builder> deleteNamespaceRequest)Deletes a namespace from the current account.default DeleteNamespaceResponsedeleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)Deletes a namespace from the current account.default DeleteServiceResponsedeleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest)Deletes a specified service and all associated service attributes.default DeleteServiceResponsedeleteService(DeleteServiceRequest deleteServiceRequest)Deletes a specified service and all associated service attributes.default DeleteServiceAttributesResponsedeleteServiceAttributes(Consumer<DeleteServiceAttributesRequest.Builder> deleteServiceAttributesRequest)Deletes specific attributes associated with a service.default DeleteServiceAttributesResponsedeleteServiceAttributes(DeleteServiceAttributesRequest deleteServiceAttributesRequest)Deletes specific attributes associated with a service.default DeregisterInstanceResponsederegisterInstance(Consumer<DeregisterInstanceRequest.Builder> deregisterInstanceRequest)Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.default DeregisterInstanceResponsederegisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.default DiscoverInstancesResponsediscoverInstances(Consumer<DiscoverInstancesRequest.Builder> discoverInstancesRequest)Discovers registered instances for a specified namespace and service.default DiscoverInstancesResponsediscoverInstances(DiscoverInstancesRequest discoverInstancesRequest)Discovers registered instances for a specified namespace and service.default DiscoverInstancesRevisionResponsediscoverInstancesRevision(Consumer<DiscoverInstancesRevisionRequest.Builder> discoverInstancesRevisionRequest)Discovers the increasing revision associated with an instance.default DiscoverInstancesRevisionResponsediscoverInstancesRevision(DiscoverInstancesRevisionRequest discoverInstancesRevisionRequest)Discovers the increasing revision associated with an instance.default GetInstanceResponsegetInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest)Gets information about a specified instance.default GetInstanceResponsegetInstance(GetInstanceRequest getInstanceRequest)Gets information about a specified instance.default GetInstancesHealthStatusResponsegetInstancesHealthStatus(Consumer<GetInstancesHealthStatusRequest.Builder> getInstancesHealthStatusRequest)Gets the current health status (Healthy,Unhealthy, orUnknown) of one or more instances that are associated with a specified service.default GetInstancesHealthStatusResponsegetInstancesHealthStatus(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest)Gets the current health status (Healthy,Unhealthy, orUnknown) of one or more instances that are associated with a specified service.default GetInstancesHealthStatusIterablegetInstancesHealthStatusPaginator(Consumer<GetInstancesHealthStatusRequest.Builder> getInstancesHealthStatusRequest)This is a variant ofgetInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest)operation.default GetInstancesHealthStatusIterablegetInstancesHealthStatusPaginator(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest)This is a variant ofgetInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest)operation.default GetNamespaceResponsegetNamespace(Consumer<GetNamespaceRequest.Builder> getNamespaceRequest)Gets information about a namespace.default GetNamespaceResponsegetNamespace(GetNamespaceRequest getNamespaceRequest)Gets information about a namespace.default GetOperationResponsegetOperation(Consumer<GetOperationRequest.Builder> getOperationRequest)Gets information about any operation that returns an operation ID in the response, such as aCreateHttpNamespacerequest.default GetOperationResponsegetOperation(GetOperationRequest getOperationRequest)Gets information about any operation that returns an operation ID in the response, such as aCreateHttpNamespacerequest.default GetServiceResponsegetService(Consumer<GetServiceRequest.Builder> getServiceRequest)Gets the settings for a specified service.default GetServiceResponsegetService(GetServiceRequest getServiceRequest)Gets the settings for a specified service.default GetServiceAttributesResponsegetServiceAttributes(Consumer<GetServiceAttributesRequest.Builder> getServiceAttributesRequest)Returns the attributes associated with a specified service.default GetServiceAttributesResponsegetServiceAttributes(GetServiceAttributesRequest getServiceAttributesRequest)Returns the attributes associated with a specified service.default ListInstancesResponselistInstances(Consumer<ListInstancesRequest.Builder> listInstancesRequest)Lists summary information about the instances that you registered by using a specified service.default ListInstancesResponselistInstances(ListInstancesRequest listInstancesRequest)Lists summary information about the instances that you registered by using a specified service.default ListInstancesIterablelistInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest)This is a variant oflistInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest)operation.default ListInstancesIterablelistInstancesPaginator(ListInstancesRequest listInstancesRequest)This is a variant oflistInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest)operation.default ListNamespacesResponselistNamespaces()Lists summary information about the namespaces that were created by the current Amazon Web Services account.default ListNamespacesResponselistNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)Lists summary information about the namespaces that were created by the current Amazon Web Services account.default ListNamespacesResponselistNamespaces(ListNamespacesRequest listNamespacesRequest)Lists summary information about the namespaces that were created by the current Amazon Web Services account.default ListNamespacesIterablelistNamespacesPaginator()This is a variant oflistNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest)operation.default ListNamespacesIterablelistNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest)This is a variant oflistNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest)operation.default ListNamespacesIterablelistNamespacesPaginator(ListNamespacesRequest listNamespacesRequest)This is a variant oflistNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest)operation.default ListOperationsResponselistOperations()Lists operations that match the criteria that you specify.default ListOperationsResponselistOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest)Lists operations that match the criteria that you specify.default ListOperationsResponselistOperations(ListOperationsRequest listOperationsRequest)Lists operations that match the criteria that you specify.default ListOperationsIterablelistOperationsPaginator()This is a variant oflistOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest)operation.default ListOperationsIterablelistOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest)This is a variant oflistOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest)operation.default ListOperationsIterablelistOperationsPaginator(ListOperationsRequest listOperationsRequest)This is a variant oflistOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest)operation.default ListServicesResponselistServices()Lists summary information for all the services that are associated with one or more namespaces.default ListServicesResponselistServices(Consumer<ListServicesRequest.Builder> listServicesRequest)Lists summary information for all the services that are associated with one or more namespaces.default ListServicesResponselistServices(ListServicesRequest listServicesRequest)Lists summary information for all the services that are associated with one or more namespaces.default ListServicesIterablelistServicesPaginator()This is a variant oflistServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest)operation.default ListServicesIterablelistServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest)This is a variant oflistServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest)operation.default ListServicesIterablelistServicesPaginator(ListServicesRequest listServicesRequest)This is a variant oflistServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists tags for the specified resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists tags for the specified resource.default RegisterInstanceResponseregisterInstance(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 RegisterInstanceResponseregisterInstance(RegisterInstanceRequest registerInstanceRequest)Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service.default ServiceDiscoveryServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds one or more tags to the specified resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Adds one or more tags to the specified resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes one or more tags from the specified resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes one or more tags from the specified resource.default UpdateHttpNamespaceResponseupdateHttpNamespace(Consumer<UpdateHttpNamespaceRequest.Builder> updateHttpNamespaceRequest)Updates an HTTP namespace.default UpdateHttpNamespaceResponseupdateHttpNamespace(UpdateHttpNamespaceRequest updateHttpNamespaceRequest)Updates an HTTP namespace.default UpdateInstanceCustomHealthStatusResponseupdateInstanceCustomHealthStatus(Consumer<UpdateInstanceCustomHealthStatusRequest.Builder> updateInstanceCustomHealthStatusRequest)Submits a request to change the health status of a custom health check to healthy or unhealthy.default UpdateInstanceCustomHealthStatusResponseupdateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest updateInstanceCustomHealthStatusRequest)Submits a request to change the health status of a custom health check to healthy or unhealthy.default UpdatePrivateDnsNamespaceResponseupdatePrivateDnsNamespace(Consumer<UpdatePrivateDnsNamespaceRequest.Builder> updatePrivateDnsNamespaceRequest)Updates a private DNS namespace.default UpdatePrivateDnsNamespaceResponseupdatePrivateDnsNamespace(UpdatePrivateDnsNamespaceRequest updatePrivateDnsNamespaceRequest)Updates a private DNS namespace.default UpdatePublicDnsNamespaceResponseupdatePublicDnsNamespace(Consumer<UpdatePublicDnsNamespaceRequest.Builder> updatePublicDnsNamespaceRequest)Updates a public DNS namespace.default UpdatePublicDnsNamespaceResponseupdatePublicDnsNamespace(UpdatePublicDnsNamespaceRequest updatePublicDnsNamespaceRequest)Updates a public DNS namespace.default UpdateServiceResponseupdateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest)Submits a request to perform the following operations:default UpdateServiceResponseupdateService(UpdateServiceRequest updateServiceRequest)Submits a request to perform the following operations:default UpdateServiceAttributesResponseupdateServiceAttributes(Consumer<UpdateServiceAttributesRequest.Builder> updateServiceAttributesRequest)Submits a request to update a specified service to add service-level attributes.default UpdateServiceAttributesResponseupdateServiceAttributes(UpdateServiceAttributesRequest updateServiceAttributesRequest)Submits a request to update a specified service to add service-level attributes.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createHttpNamespace
default CreateHttpNamespaceResponse createHttpNamespace(CreateHttpNamespaceRequest createHttpNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, TooManyTagsException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a
DiscoverInstancesrequest but can't be discovered using DNS.For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.
- Parameters:
createHttpNamespaceRequest-- Returns:
- Result of the CreateHttpNamespace operation returned by the service.
- Throws:
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 quota on the number of resources.DuplicateRequestException- The operation is already in progress.TooManyTagsException- The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.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.AwsServiceException- See Also:
- AWS API Documentation
-
createHttpNamespace
default CreateHttpNamespaceResponse createHttpNamespace(Consumer<CreateHttpNamespaceRequest.Builder> createHttpNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, TooManyTagsException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a
DiscoverInstancesrequest but can't be discovered using DNS.For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.
This is a convenience which creates an instance of the
CreateHttpNamespaceRequest.Builderavoiding the need to create one manually viaCreateHttpNamespaceRequest.builder()- Parameters:
createHttpNamespaceRequest- AConsumerthat will call methods onCreateHttpNamespaceRequest.Builderto create a request.- Returns:
- Result of the CreateHttpNamespace operation returned by the service.
- Throws:
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 quota on the number of resources.DuplicateRequestException- The operation is already in progress.TooManyTagsException- The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPrivateDnsNamespace
default CreatePrivateDnsNamespaceResponse createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest createPrivateDnsNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, TooManyTagsException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace
example.comand name your servicebackend, the resulting DNS name for the service isbackend.example.com. Service instances that are registered using a private DNS namespace can be discovered using either aDiscoverInstancesrequest or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.- Parameters:
createPrivateDnsNamespaceRequest-- Returns:
- Result of the CreatePrivateDnsNamespace operation returned by the service.
- Throws:
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 quota on the number of resources.DuplicateRequestException- The operation is already in progress.TooManyTagsException- The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPrivateDnsNamespace
default CreatePrivateDnsNamespaceResponse createPrivateDnsNamespace(Consumer<CreatePrivateDnsNamespaceRequest.Builder> createPrivateDnsNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, TooManyTagsException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace
example.comand name your servicebackend, the resulting DNS name for the service isbackend.example.com. Service instances that are registered using a private DNS namespace can be discovered using either aDiscoverInstancesrequest or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.
This is a convenience which creates an instance of the
CreatePrivateDnsNamespaceRequest.Builderavoiding the need to create one manually viaCreatePrivateDnsNamespaceRequest.builder()- Parameters:
createPrivateDnsNamespaceRequest- AConsumerthat will call methods onCreatePrivateDnsNamespaceRequest.Builderto create a request.- Returns:
- Result of the CreatePrivateDnsNamespace operation returned by the service.
- Throws:
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 quota on the number of resources.DuplicateRequestException- The operation is already in progress.TooManyTagsException- The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPublicDnsNamespace
default CreatePublicDnsNamespaceResponse createPublicDnsNamespace(CreatePublicDnsNamespaceRequest createPublicDnsNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, TooManyTagsException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace
example.comand name your servicebackend, the resulting DNS name for the service isbackend.example.com. You can discover instances that were registered with a public DNS namespace by using either aDiscoverInstancesrequest or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.The
CreatePublicDnsNamespaceAPI operation is not supported in the Amazon Web Services GovCloud (US) Regions.- Parameters:
createPublicDnsNamespaceRequest-- Returns:
- Result of the CreatePublicDnsNamespace operation returned by the service.
- Throws:
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 quota on the number of resources.DuplicateRequestException- The operation is already in progress.TooManyTagsException- The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPublicDnsNamespace
default CreatePublicDnsNamespaceResponse createPublicDnsNamespace(Consumer<CreatePublicDnsNamespaceRequest.Builder> createPublicDnsNamespaceRequest) throws InvalidInputException, NamespaceAlreadyExistsException, ResourceLimitExceededException, DuplicateRequestException, TooManyTagsException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace
example.comand name your servicebackend, the resulting DNS name for the service isbackend.example.com. You can discover instances that were registered with a public DNS namespace by using either aDiscoverInstancesrequest or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.The
CreatePublicDnsNamespaceAPI operation is not supported in the Amazon Web Services GovCloud (US) Regions.
This is a convenience which creates an instance of the
CreatePublicDnsNamespaceRequest.Builderavoiding the need to create one manually viaCreatePublicDnsNamespaceRequest.builder()- Parameters:
createPublicDnsNamespaceRequest- AConsumerthat will call methods onCreatePublicDnsNamespaceRequest.Builderto create a request.- Returns:
- Result of the CreatePublicDnsNamespace operation returned by the service.
- Throws:
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 quota on the number of resources.DuplicateRequestException- The operation is already in progress.TooManyTagsException- The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.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.AwsServiceException- See Also:
- AWS API Documentation
-
createService
default CreateServiceResponse createService(CreateServiceRequest createServiceRequest) throws InvalidInputException, ResourceLimitExceededException, NamespaceNotFoundException, ServiceAlreadyExistsException, TooManyTagsException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a service. This action 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 -
AandAAAA -
SRV -
CNAME
-
-
Optionally, a health check
After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the values in the configuration to create the specified entities.
For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
- Parameters:
createServiceRequest-- Returns:
- Result of the CreateService operation returned by the service.
- Throws:
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 quota 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.TooManyTagsException- The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createService
default CreateServiceResponse createService(Consumer<CreateServiceRequest.Builder> createServiceRequest) throws InvalidInputException, ResourceLimitExceededException, NamespaceNotFoundException, ServiceAlreadyExistsException, TooManyTagsException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Creates a service. This action 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 -
AandAAAA -
SRV -
CNAME
-
-
Optionally, a health check
After you create the service, you can submit a RegisterInstance request, and Cloud Map uses the values in the configuration to create the specified entities.
For the current quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
This is a convenience which creates an instance of the
CreateServiceRequest.Builderavoiding the need to create one manually viaCreateServiceRequest.builder()- Parameters:
createServiceRequest- AConsumerthat will call methods onCreateServiceRequest.Builderto create a request.- Returns:
- Result of the CreateService operation returned by the service.
- Throws:
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 quota 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.TooManyTagsException- The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteNamespace
default 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.
- Parameters:
deleteNamespaceRequest-- Returns:
- Result of the DeleteNamespace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNamespace
default 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.Builderavoiding the need to create one manually viaDeleteNamespaceRequest.builder()- Parameters:
deleteNamespaceRequest- AConsumerthat will call methods onDeleteNamespaceRequest.Builderto create a request.- Returns:
- Result of the DeleteNamespace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteService
default DeleteServiceResponse deleteService(DeleteServiceRequest deleteServiceRequest) throws InvalidInputException, ServiceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Deletes a specified service and all associated service attributes. If the service still contains one or more registered instances, the request fails.
- Parameters:
deleteServiceRequest-- Returns:
- Result of the DeleteService operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteService
default DeleteServiceResponse deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest) throws InvalidInputException, ServiceNotFoundException, ResourceInUseException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Deletes a specified service and all associated service attributes. If the service still contains one or more registered instances, the request fails.
This is a convenience which creates an instance of the
DeleteServiceRequest.Builderavoiding the need to create one manually viaDeleteServiceRequest.builder()- Parameters:
deleteServiceRequest- AConsumerthat will call methods onDeleteServiceRequest.Builderto create a request.- Returns:
- Result of the DeleteService operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServiceAttributes
default DeleteServiceAttributesResponse deleteServiceAttributes(DeleteServiceAttributesRequest deleteServiceAttributesRequest) throws InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Deletes specific attributes associated with a service.
- Parameters:
deleteServiceAttributesRequest-- Returns:
- Result of the DeleteServiceAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteServiceAttributes
default DeleteServiceAttributesResponse deleteServiceAttributes(Consumer<DeleteServiceAttributesRequest.Builder> deleteServiceAttributesRequest) throws InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Deletes specific attributes associated with a service.
This is a convenience which creates an instance of the
DeleteServiceAttributesRequest.Builderavoiding the need to create one manually viaDeleteServiceAttributesRequest.builder()- Parameters:
deleteServiceAttributesRequest- AConsumerthat will call methods onDeleteServiceAttributesRequest.Builderto create a request.- Returns:
- Result of the DeleteServiceAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterInstance
default 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 Cloud Map created for the specified instance.
- Parameters:
deregisterInstanceRequest-- Returns:
- Result of the DeregisterInstance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterInstance
default 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 Cloud Map created for the specified instance.
This is a convenience which creates an instance of the
DeregisterInstanceRequest.Builderavoiding the need to create one manually viaDeregisterInstanceRequest.builder()- Parameters:
deregisterInstanceRequest- AConsumerthat will call methods onDeregisterInstanceRequest.Builderto create a request.- Returns:
- Result of the DeregisterInstance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
discoverInstances
default DiscoverInstancesResponse discoverInstances(DiscoverInstancesRequest discoverInstancesRequest) throws ServiceNotFoundException, NamespaceNotFoundException, InvalidInputException, RequestLimitExceededException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Discovers registered instances for a specified namespace and service. You can use
DiscoverInstancesto discover instances for any type of namespace.DiscoverInstancesreturns a randomized list of instances allowing customers to distribute traffic evenly across instances. For public and private DNS namespaces, you can also use DNS queries to discover instances.- Parameters:
discoverInstancesRequest-- Returns:
- Result of the DiscoverInstances operation returned by the service.
- Throws:
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.RequestLimitExceededException- The operation can't be completed because you've reached the quota for the number of requests. For more information, see Cloud Map API request throttling quota in the Cloud Map Developer Guide.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.AwsServiceException- See Also:
- AWS API Documentation
-
discoverInstances
default DiscoverInstancesResponse discoverInstances(Consumer<DiscoverInstancesRequest.Builder> discoverInstancesRequest) throws ServiceNotFoundException, NamespaceNotFoundException, InvalidInputException, RequestLimitExceededException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Discovers registered instances for a specified namespace and service. You can use
DiscoverInstancesto discover instances for any type of namespace.DiscoverInstancesreturns a randomized list of instances allowing customers to distribute traffic evenly across instances. For public and private DNS namespaces, you can also use DNS queries to discover instances.
This is a convenience which creates an instance of the
DiscoverInstancesRequest.Builderavoiding the need to create one manually viaDiscoverInstancesRequest.builder()- Parameters:
discoverInstancesRequest- AConsumerthat will call methods onDiscoverInstancesRequest.Builderto create a request.- Returns:
- Result of the DiscoverInstances operation returned by the service.
- Throws:
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.RequestLimitExceededException- The operation can't be completed because you've reached the quota for the number of requests. For more information, see Cloud Map API request throttling quota in the Cloud Map Developer Guide.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.AwsServiceException- See Also:
- AWS API Documentation
-
discoverInstancesRevision
default DiscoverInstancesRevisionResponse discoverInstancesRevision(DiscoverInstancesRevisionRequest discoverInstancesRevisionRequest) throws ServiceNotFoundException, NamespaceNotFoundException, InvalidInputException, RequestLimitExceededException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Discovers the increasing revision associated with an instance.
- Parameters:
discoverInstancesRevisionRequest-- Returns:
- Result of the DiscoverInstancesRevision operation returned by the service.
- Throws:
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.RequestLimitExceededException- The operation can't be completed because you've reached the quota for the number of requests. For more information, see Cloud Map API request throttling quota in the Cloud Map Developer Guide.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.AwsServiceException- See Also:
- AWS API Documentation
-
discoverInstancesRevision
default DiscoverInstancesRevisionResponse discoverInstancesRevision(Consumer<DiscoverInstancesRevisionRequest.Builder> discoverInstancesRevisionRequest) throws ServiceNotFoundException, NamespaceNotFoundException, InvalidInputException, RequestLimitExceededException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Discovers the increasing revision associated with an instance.
This is a convenience which creates an instance of the
DiscoverInstancesRevisionRequest.Builderavoiding the need to create one manually viaDiscoverInstancesRevisionRequest.builder()- Parameters:
discoverInstancesRevisionRequest- AConsumerthat will call methods onDiscoverInstancesRevisionRequest.Builderto create a request.- Returns:
- Result of the DiscoverInstancesRevision operation returned by the service.
- Throws:
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.RequestLimitExceededException- The operation can't be completed because you've reached the quota for the number of requests. For more information, see Cloud Map API request throttling quota in the Cloud Map Developer Guide.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.AwsServiceException- See Also:
- AWS API Documentation
-
getInstance
default GetInstanceResponse getInstance(GetInstanceRequest getInstanceRequest) throws InstanceNotFoundException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets information about a specified instance.
- Parameters:
getInstanceRequest-- Returns:
- Result of the GetInstance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getInstance
default 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.Builderavoiding the need to create one manually viaGetInstanceRequest.builder()- Parameters:
getInstanceRequest- AConsumerthat will call methods onGetInstanceRequest.Builderto create a request.- Returns:
- Result of the GetInstance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getInstancesHealthStatus
default GetInstancesHealthStatusResponse getInstancesHealthStatus(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest) throws InstanceNotFoundException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets the current health status (
Healthy,Unhealthy, orUnknown) of one or more instances that are associated with a specified service.There's a brief delay between when you register an instance and when the health status for the instance is available.
- Parameters:
getInstancesHealthStatusRequest-- Returns:
- Result of the GetInstancesHealthStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getInstancesHealthStatus
default GetInstancesHealthStatusResponse getInstancesHealthStatus(Consumer<GetInstancesHealthStatusRequest.Builder> getInstancesHealthStatusRequest) throws InstanceNotFoundException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets the current health status (
Healthy,Unhealthy, orUnknown) of one or more instances that are associated with a specified service.There's 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.Builderavoiding the need to create one manually viaGetInstancesHealthStatusRequest.builder()- Parameters:
getInstancesHealthStatusRequest- AConsumerthat will call methods onGetInstancesHealthStatusRequest.Builderto create a request.- Returns:
- Result of the GetInstancesHealthStatus operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getInstancesHealthStatusPaginator
default GetInstancesHealthStatusIterable getInstancesHealthStatusPaginator(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest) throws InstanceNotFoundException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusIterable responses = client.getInstancesHealthStatusPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusIterable responses = client.getInstancesHealthStatusPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest)operation.- Parameters:
getInstancesHealthStatusRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getInstancesHealthStatusPaginator
default GetInstancesHealthStatusIterable getInstancesHealthStatusPaginator(Consumer<GetInstancesHealthStatusRequest.Builder> getInstancesHealthStatusRequest) throws InstanceNotFoundException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusIterable responses = client.getInstancesHealthStatusPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.GetInstancesHealthStatusIterable responses = client.getInstancesHealthStatusPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInstancesHealthStatus(software.amazon.awssdk.services.servicediscovery.model.GetInstancesHealthStatusRequest)operation.
This is a convenience which creates an instance of the
GetInstancesHealthStatusRequest.Builderavoiding the need to create one manually viaGetInstancesHealthStatusRequest.builder()- Parameters:
getInstancesHealthStatusRequest- AConsumerthat will call methods onGetInstancesHealthStatusRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getNamespace
default GetNamespaceResponse getNamespace(GetNamespaceRequest getNamespaceRequest) throws InvalidInputException, NamespaceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets information about a namespace.
- Parameters:
getNamespaceRequest-- Returns:
- Result of the GetNamespace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getNamespace
default 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.Builderavoiding the need to create one manually viaGetNamespaceRequest.builder()- Parameters:
getNamespaceRequest- AConsumerthat will call methods onGetNamespaceRequest.Builderto create a request.- Returns:
- Result of the GetNamespace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getOperation
default 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
CreateHttpNamespacerequest.To get a list of operations that match specified criteria, see ListOperations.
- Parameters:
getOperationRequest-- Returns:
- Result of the GetOperation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getOperation
default 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
CreateHttpNamespacerequest.To get a list of operations that match specified criteria, see ListOperations.
This is a convenience which creates an instance of the
GetOperationRequest.Builderavoiding the need to create one manually viaGetOperationRequest.builder()- Parameters:
getOperationRequest- AConsumerthat will call methods onGetOperationRequest.Builderto create a request.- Returns:
- Result of the GetOperation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getService
default GetServiceResponse getService(GetServiceRequest getServiceRequest) throws InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Gets the settings for a specified service.
- Parameters:
getServiceRequest-- Returns:
- Result of the GetService operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getService
default 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.Builderavoiding the need to create one manually viaGetServiceRequest.builder()- Parameters:
getServiceRequest- AConsumerthat will call methods onGetServiceRequest.Builderto create a request.- Returns:
- Result of the GetService operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getServiceAttributes
default GetServiceAttributesResponse getServiceAttributes(GetServiceAttributesRequest getServiceAttributesRequest) throws InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Returns the attributes associated with a specified service.
- Parameters:
getServiceAttributesRequest-- Returns:
- Result of the GetServiceAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getServiceAttributes
default GetServiceAttributesResponse getServiceAttributes(Consumer<GetServiceAttributesRequest.Builder> getServiceAttributesRequest) throws InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Returns the attributes associated with a specified service.
This is a convenience which creates an instance of the
GetServiceAttributesRequest.Builderavoiding the need to create one manually viaGetServiceAttributesRequest.builder()- Parameters:
getServiceAttributesRequest- AConsumerthat will call methods onGetServiceAttributesRequest.Builderto create a request.- Returns:
- Result of the GetServiceAttributes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listInstances
default ListInstancesResponse listInstances(ListInstancesRequest listInstancesRequest) throws ServiceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the instances that you registered by using a specified service.
- Parameters:
listInstancesRequest-- Returns:
- Result of the ListInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listInstances
default 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.Builderavoiding the need to create one manually viaListInstancesRequest.builder()- Parameters:
listInstancesRequest- AConsumerthat will call methods onListInstancesRequest.Builderto create a request.- Returns:
- Result of the ListInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listInstancesPaginator
default ListInstancesIterable listInstancesPaginator(ListInstancesRequest listInstancesRequest) throws ServiceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest)operation.- Parameters:
listInstancesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listInstancesPaginator
default ListInstancesIterable listInstancesPaginator(Consumer<ListInstancesRequest.Builder> listInstancesRequest) throws ServiceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.ListInstancesIterable responses = client.listInstancesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listInstances(software.amazon.awssdk.services.servicediscovery.model.ListInstancesRequest)operation.
This is a convenience which creates an instance of the
ListInstancesRequest.Builderavoiding the need to create one manually viaListInstancesRequest.builder()- Parameters:
listInstancesRequest- AConsumerthat will call methods onListInstancesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamespaces
default ListNamespacesResponse listNamespaces(ListNamespacesRequest listNamespacesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the namespaces that were created by the current Amazon Web Services account.
- Parameters:
listNamespacesRequest-- Returns:
- Result of the ListNamespaces operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamespaces
default ListNamespacesResponse listNamespaces(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the namespaces that were created by the current Amazon Web Services account.
This is a convenience which creates an instance of the
ListNamespacesRequest.Builderavoiding the need to create one manually viaListNamespacesRequest.builder()- Parameters:
listNamespacesRequest- AConsumerthat will call methods onListNamespacesRequest.Builderto create a request.- Returns:
- Result of the ListNamespaces operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamespaces
default ListNamespacesResponse listNamespaces() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information about the namespaces that were created by the current Amazon Web Services account.
- Returns:
- Result of the ListNamespaces operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listNamespaces(ListNamespacesRequest), AWS API Documentation
-
listNamespacesPaginator
default ListNamespacesIterable listNamespacesPaginator() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listNamespacesPaginator(ListNamespacesRequest), AWS API Documentation
-
listNamespacesPaginator
default ListNamespacesIterable listNamespacesPaginator(ListNamespacesRequest listNamespacesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest)operation.- Parameters:
listNamespacesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listNamespacesPaginator
default ListNamespacesIterable listNamespacesPaginator(Consumer<ListNamespacesRequest.Builder> listNamespacesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.ListNamespacesIterable responses = client.listNamespacesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listNamespaces(software.amazon.awssdk.services.servicediscovery.model.ListNamespacesRequest)operation.
This is a convenience which creates an instance of the
ListNamespacesRequest.Builderavoiding the need to create one manually viaListNamespacesRequest.builder()- Parameters:
listNamespacesRequest- AConsumerthat will call methods onListNamespacesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listOperations
default ListOperationsResponse listOperations(ListOperationsRequest listOperationsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists operations that match the criteria that you specify.
- Parameters:
listOperationsRequest-- Returns:
- Result of the ListOperations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listOperations
default 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.Builderavoiding the need to create one manually viaListOperationsRequest.builder()- Parameters:
listOperationsRequest- AConsumerthat will call methods onListOperationsRequest.Builderto create a request.- Returns:
- Result of the ListOperations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listOperations
default ListOperationsResponse listOperations() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists operations that match the criteria that you specify.
- Returns:
- Result of the ListOperations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listOperations(ListOperationsRequest), AWS API Documentation
-
listOperationsPaginator
default ListOperationsIterable listOperationsPaginator() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listOperationsPaginator(ListOperationsRequest), AWS API Documentation
-
listOperationsPaginator
default ListOperationsIterable listOperationsPaginator(ListOperationsRequest listOperationsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest)operation.- Parameters:
listOperationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listOperationsPaginator
default ListOperationsIterable listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listOperations(software.amazon.awssdk.services.servicediscovery.model.ListOperationsRequest)operation.
This is a convenience which creates an instance of the
ListOperationsRequest.Builderavoiding the need to create one manually viaListOperationsRequest.builder()- Parameters:
listOperationsRequest- AConsumerthat will call methods onListOperationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServices
default ListServicesResponse listServices(ListServicesRequest listServicesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information for all the services that are associated with one or more namespaces.
- Parameters:
listServicesRequest-- Returns:
- Result of the ListServices operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServices
default 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 namespaces.
This is a convenience which creates an instance of the
ListServicesRequest.Builderavoiding the need to create one manually viaListServicesRequest.builder()- Parameters:
listServicesRequest- AConsumerthat will call methods onListServicesRequest.Builderto create a request.- Returns:
- Result of the ListServices operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServices
default ListServicesResponse listServices() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists summary information for all the services that are associated with one or more namespaces.
- Returns:
- Result of the ListServices operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listServices(ListServicesRequest), AWS API Documentation
-
listServicesPaginator
default ListServicesIterable listServicesPaginator() throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listServicesPaginator(ListServicesRequest), AWS API Documentation
-
listServicesPaginator
default ListServicesIterable listServicesPaginator(ListServicesRequest listServicesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest)operation.- Parameters:
listServicesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listServicesPaginator
default ListServicesIterable listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest) throws InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
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
2) Using For loopsoftware.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.amazon.awssdk.services.servicediscovery.paginators.ListServicesIterable responses = client.listServicesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.servicediscovery.model.ListServicesRequest)operation.
This is a convenience which creates an instance of the
ListServicesRequest.Builderavoiding the need to create one manually viaListServicesRequest.builder()- Parameters:
listServicesRequest- AConsumerthat will call methods onListServicesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists tags for the specified resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The operation can't be completed because the resource was not found.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Lists tags for the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The operation can't be completed because the resource was not found.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.AwsServiceException- See Also:
- AWS API Documentation
-
registerInstance
default 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
RegisterInstancerequest, the following occurs:-
For each DNS record that you define in the service that's specified by
ServiceId, a record is created or updated in the hosted zone that's 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
RegisterInstancerequest must complete before you can submit another request and specify the same service ID and instance ID.For more information, see CreateService.
When 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 quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
- Parameters:
registerInstanceRequest-- Returns:
- Result of the RegisterInstance operation returned by the service.
- Throws:
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 quota 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
registerInstance
default 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
RegisterInstancerequest, the following occurs:-
For each DNS record that you define in the service that's specified by
ServiceId, a record is created or updated in the hosted zone that's 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
RegisterInstancerequest must complete before you can submit another request and specify the same service ID and instance ID.For more information, see CreateService.
When 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 quota on the number of instances that you can register using the same namespace and using the same service, see Cloud Map quotas in the Cloud Map Developer Guide.
This is a convenience which creates an instance of the
RegisterInstanceRequest.Builderavoiding the need to create one manually viaRegisterInstanceRequest.builder()- Parameters:
registerInstanceRequest- AConsumerthat will call methods onRegisterInstanceRequest.Builderto create a request.- Returns:
- Result of the RegisterInstance operation returned by the service.
- Throws:
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 quota 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.AwsServiceException- See Also:
- AWS API Documentation
-
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, TooManyTagsException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Adds one or more tags to the specified resource.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The operation can't be completed because the resource was not found.TooManyTagsException- The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, TooManyTagsException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Adds one or more tags to the specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The operation can't be completed because the resource was not found.TooManyTagsException- The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Removes one or more tags from the specified resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The operation can't be completed because the resource was not found.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InvalidInputException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Removes one or more tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The operation can't be completed because the resource was not found.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateHttpNamespace
default UpdateHttpNamespaceResponse updateHttpNamespace(UpdateHttpNamespaceRequest updateHttpNamespaceRequest) throws InvalidInputException, NamespaceNotFoundException, ResourceInUseException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Updates an HTTP namespace.
- Parameters:
updateHttpNamespaceRequest-- Returns:
- Result of the UpdateHttpNamespace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateHttpNamespace
default UpdateHttpNamespaceResponse updateHttpNamespace(Consumer<UpdateHttpNamespaceRequest.Builder> updateHttpNamespaceRequest) throws InvalidInputException, NamespaceNotFoundException, ResourceInUseException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Updates an HTTP namespace.
This is a convenience which creates an instance of the
UpdateHttpNamespaceRequest.Builderavoiding the need to create one manually viaUpdateHttpNamespaceRequest.builder()- Parameters:
updateHttpNamespaceRequest- AConsumerthat will call methods onUpdateHttpNamespaceRequest.Builderto create a request.- Returns:
- Result of the UpdateHttpNamespace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateInstanceCustomHealthStatus
default 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
UpdateInstanceCustomHealthStatusto change the status only for custom health checks, which you define usingHealthCheckCustomConfigwhen you create a service. You can't use it to change the status for Route 53 health checks, which you define usingHealthCheckConfig.For more information, see HealthCheckCustomConfig.
- Parameters:
updateInstanceCustomHealthStatusRequest-- Returns:
- Result of the UpdateInstanceCustomHealthStatus operation returned by the service.
- Throws:
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's specified byServiceIdandInstanceIdisn't 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateInstanceCustomHealthStatus
default 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
UpdateInstanceCustomHealthStatusto change the status only for custom health checks, which you define usingHealthCheckCustomConfigwhen you create a service. You can't use it to change the status for Route 53 health checks, which you define usingHealthCheckConfig.For more information, see HealthCheckCustomConfig.
This is a convenience which creates an instance of the
UpdateInstanceCustomHealthStatusRequest.Builderavoiding the need to create one manually viaUpdateInstanceCustomHealthStatusRequest.builder()- Parameters:
updateInstanceCustomHealthStatusRequest- AConsumerthat will call methods onUpdateInstanceCustomHealthStatusRequest.Builderto create a request.- Returns:
- Result of the UpdateInstanceCustomHealthStatus operation returned by the service.
- Throws:
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's specified byServiceIdandInstanceIdisn't 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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePrivateDnsNamespace
default UpdatePrivateDnsNamespaceResponse updatePrivateDnsNamespace(UpdatePrivateDnsNamespaceRequest updatePrivateDnsNamespaceRequest) throws InvalidInputException, NamespaceNotFoundException, ResourceInUseException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Updates a private DNS namespace.
- Parameters:
updatePrivateDnsNamespaceRequest-- Returns:
- Result of the UpdatePrivateDnsNamespace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePrivateDnsNamespace
default UpdatePrivateDnsNamespaceResponse updatePrivateDnsNamespace(Consumer<UpdatePrivateDnsNamespaceRequest.Builder> updatePrivateDnsNamespaceRequest) throws InvalidInputException, NamespaceNotFoundException, ResourceInUseException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Updates a private DNS namespace.
This is a convenience which creates an instance of the
UpdatePrivateDnsNamespaceRequest.Builderavoiding the need to create one manually viaUpdatePrivateDnsNamespaceRequest.builder()- Parameters:
updatePrivateDnsNamespaceRequest- AConsumerthat will call methods onUpdatePrivateDnsNamespaceRequest.Builderto create a request.- Returns:
- Result of the UpdatePrivateDnsNamespace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePublicDnsNamespace
default UpdatePublicDnsNamespaceResponse updatePublicDnsNamespace(UpdatePublicDnsNamespaceRequest updatePublicDnsNamespaceRequest) throws InvalidInputException, NamespaceNotFoundException, ResourceInUseException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Updates a public DNS namespace.
- Parameters:
updatePublicDnsNamespaceRequest-- Returns:
- Result of the UpdatePublicDnsNamespace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePublicDnsNamespace
default UpdatePublicDnsNamespaceResponse updatePublicDnsNamespace(Consumer<UpdatePublicDnsNamespaceRequest.Builder> updatePublicDnsNamespaceRequest) throws InvalidInputException, NamespaceNotFoundException, ResourceInUseException, DuplicateRequestException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Updates a public DNS namespace.
This is a convenience which creates an instance of the
UpdatePublicDnsNamespaceRequest.Builderavoiding the need to create one manually viaUpdatePublicDnsNamespaceRequest.builder()- Parameters:
updatePublicDnsNamespaceRequest- AConsumerthat will call methods onUpdatePublicDnsNamespaceRequest.Builderto create a request.- Returns:
- Result of the UpdatePublicDnsNamespace operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateService
default UpdateServiceResponse updateService(UpdateServiceRequest updateServiceRequest) throws DuplicateRequestException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Submits a request to perform the following operations:
-
Update the TTL setting for existing
DnsRecordsconfigurations -
Add, update, or delete
HealthCheckConfigfor a specified serviceYou can't add, update, or delete a
HealthCheckCustomConfigconfiguration.
For public and private DNS namespaces, note the following:
-
If you omit any existing
DnsRecordsorHealthCheckConfigconfigurations from anUpdateServicerequest, the configurations are deleted from the service. -
If you omit an existing
HealthCheckCustomConfigconfiguration from anUpdateServicerequest, the configuration isn't deleted from the service.
When you update settings for a service, Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.
- Parameters:
updateServiceRequest-- Returns:
- Result of the UpdateService operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateService
default UpdateServiceResponse updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest) throws DuplicateRequestException, InvalidInputException, ServiceNotFoundException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Submits a request to perform the following operations:
-
Update the TTL setting for existing
DnsRecordsconfigurations -
Add, update, or delete
HealthCheckConfigfor a specified serviceYou can't add, update, or delete a
HealthCheckCustomConfigconfiguration.
For public and private DNS namespaces, note the following:
-
If you omit any existing
DnsRecordsorHealthCheckConfigconfigurations from anUpdateServicerequest, the configurations are deleted from the service. -
If you omit an existing
HealthCheckCustomConfigconfiguration from anUpdateServicerequest, the configuration isn't deleted from the service.
When you update settings for a service, 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.Builderavoiding the need to create one manually viaUpdateServiceRequest.builder()- Parameters:
updateServiceRequest- AConsumerthat will call methods onUpdateServiceRequest.Builderto create a request.- Returns:
- Result of the UpdateService operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateServiceAttributes
default UpdateServiceAttributesResponse updateServiceAttributes(UpdateServiceAttributesRequest updateServiceAttributesRequest) throws InvalidInputException, ServiceNotFoundException, ServiceAttributesLimitExceededException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Submits a request to update a specified service to add service-level attributes.
- Parameters:
updateServiceAttributesRequest-- Returns:
- Result of the UpdateServiceAttributes operation returned by the service.
- Throws:
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.ServiceAttributesLimitExceededException- The attribute can't be added to the service because you've exceeded the quota for the number of attributes you can add to a service.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateServiceAttributes
default UpdateServiceAttributesResponse updateServiceAttributes(Consumer<UpdateServiceAttributesRequest.Builder> updateServiceAttributesRequest) throws InvalidInputException, ServiceNotFoundException, ServiceAttributesLimitExceededException, AwsServiceException, SdkClientException, ServiceDiscoveryException
Submits a request to update a specified service to add service-level attributes.
This is a convenience which creates an instance of the
UpdateServiceAttributesRequest.Builderavoiding the need to create one manually viaUpdateServiceAttributesRequest.builder()- Parameters:
updateServiceAttributesRequest- AConsumerthat will call methods onUpdateServiceAttributesRequest.Builderto create a request.- Returns:
- Result of the UpdateServiceAttributes operation returned by the service.
- Throws:
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.ServiceAttributesLimitExceededException- The attribute can't be added to the service because you've exceeded the quota for the number of attributes you can add to a service.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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static ServiceDiscoveryClient create()
Create aServiceDiscoveryClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ServiceDiscoveryClientBuilder builder()
Create a builder that can be used to configure and create aServiceDiscoveryClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ServiceDiscoveryServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-