com.amazonaws.services.servicediscovery

Class AWSServiceDiscoveryClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.servicediscovery.AWSServiceDiscoveryClient

All Implemented Interfaces:

AWSServiceDiscovery

Direct Known Subclasses:

AWSServiceDiscoveryAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSServiceDiscoveryClient
extends AmazonWebServiceClient
implements AWSServiceDiscovery

Client for accessing ServiceDiscovery. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.servicediscovery.AWSServiceDiscovery

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSServiceDiscoveryClientBuilder	builder()
CreateHttpNamespaceResult	createHttpNamespace(CreateHttpNamespaceRequest request) Creates an HTTP namespace.
CreatePrivateDnsNamespaceResult	createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest request) Creates a private namespace based on DNS, which is visible only inside a specified Amazon VPC.
CreatePublicDnsNamespaceResult	createPublicDnsNamespace(CreatePublicDnsNamespaceRequest request) Creates a public namespace based on DNS, which is visible on the internet.
CreateServiceResult	createService(CreateServiceRequest request) Creates a service.
DeleteNamespaceResult	deleteNamespace(DeleteNamespaceRequest request) Deletes a namespace from the current account.
DeleteServiceResult	deleteService(DeleteServiceRequest request) Deletes a specified service.
DeregisterInstanceResult	deregisterInstance(DeregisterInstanceRequest request) Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.
DiscoverInstancesResult	discoverInstances(DiscoverInstancesRequest request) Discovers registered instances for a specified namespace and service.
DiscoverInstancesRevisionResult	discoverInstancesRevision(DiscoverInstancesRevisionRequest request) Discovers the increasing revision associated with an instance.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetInstanceResult	getInstance(GetInstanceRequest request) Gets information about a specified instance.
GetInstancesHealthStatusResult	getInstancesHealthStatus(GetInstancesHealthStatusRequest request) Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.
GetNamespaceResult	getNamespace(GetNamespaceRequest request) Gets information about a namespace.
GetOperationResult	getOperation(GetOperationRequest request) Gets information about any operation that returns an operation ID in the response, such as a CreateHttpNamespace request.
GetServiceResult	getService(GetServiceRequest request) Gets the settings for a specified service.
ListInstancesResult	listInstances(ListInstancesRequest request) Lists summary information about the instances that you registered by using a specified service.
ListNamespacesResult	listNamespaces(ListNamespacesRequest request) Lists summary information about the namespaces that were created by the current Amazon Web Services account.
ListOperationsResult	listOperations(ListOperationsRequest request) Lists operations that match the criteria that you specify.
ListServicesResult	listServices(ListServicesRequest request) Lists summary information for all the services that are associated with one or more namespaces.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists tags for the specified resource.
RegisterInstanceResult	registerInstance(RegisterInstanceRequest request) Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds one or more tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes one or more tags from the specified resource.
UpdateHttpNamespaceResult	updateHttpNamespace(UpdateHttpNamespaceRequest request) Updates an HTTP namespace.
UpdateInstanceCustomHealthStatusResult	updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest request) Submits a request to change the health status of a custom health check to healthy or unhealthy.
UpdatePrivateDnsNamespaceResult	updatePrivateDnsNamespace(UpdatePrivateDnsNamespaceRequest request) Updates a private DNS namespace.
UpdatePublicDnsNamespaceResult	updatePublicDnsNamespace(UpdatePublicDnsNamespaceRequest request) Updates a public DNS namespace.
UpdateServiceResult	updateService(UpdateServiceRequest request) Submits a request to perform the following operations:

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSServiceDiscoveryClientBuilder builder()

createHttpNamespace

public CreateHttpNamespaceResult createHttpNamespace(CreateHttpNamespaceRequest request)

Creates an HTTP namespace. Service instances registered using an HTTP namespace can be discovered using a DiscoverInstances request 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.

Specified by:

createHttpNamespace in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

createPrivateDnsNamespace

public CreatePrivateDnsNamespaceResult createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest request)

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.com and name your service backend, the resulting DNS name for the service is backend.example.com. Service instances that are registered using a private DNS namespace can be discovered using either a DiscoverInstances request 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.

Specified by:

createPrivateDnsNamespace in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

createPublicDnsNamespace

public CreatePublicDnsNamespaceResult createPublicDnsNamespace(CreatePublicDnsNamespaceRequest request)

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.com and name your service backend, the resulting DNS name for the service is backend.example.com. You can discover instances that were registered with a public DNS namespace by using either a DiscoverInstances request 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 CreatePublicDnsNamespace API operation is not supported in the Amazon Web Services GovCloud (US) Regions.

Specified by:

createPublicDnsNamespace in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

createService

public CreateServiceResult createService(CreateServiceRequest request)

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

  • A and AAAA

  • 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.

Specified by:

createService in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

deleteNamespace

public DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest request)

Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.

Specified by:

deleteNamespace in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

deleteService

public DeleteServiceResult deleteService(DeleteServiceRequest request)

Deletes a specified service. If the service still contains one or more registered instances, the request fails.

Specified by:

deleteService in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

deregisterInstance

public DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest request)

Deletes the Amazon Route 53 DNS records and health check, if any, that Cloud Map created for the specified instance.

Specified by:

deregisterInstance in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

discoverInstances

public DiscoverInstancesResult discoverInstances(DiscoverInstancesRequest request)

Discovers registered instances for a specified namespace and service. You can use DiscoverInstances to discover instances for any type of namespace. DiscoverInstances returns 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.

Specified by:

discoverInstances in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

discoverInstancesRevision

public DiscoverInstancesRevisionResult discoverInstancesRevision(DiscoverInstancesRevisionRequest request)

Discovers the increasing revision associated with an instance.

Specified by:

discoverInstancesRevision in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

getInstance

public GetInstanceResult getInstance(GetInstanceRequest request)

Gets information about a specified instance.

Specified by:

getInstance in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

getInstancesHealthStatus

public GetInstancesHealthStatusResult getInstancesHealthStatus(GetInstancesHealthStatusRequest request)

Gets the current health status (Healthy, Unhealthy, or Unknown) 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.

Specified by:

getInstancesHealthStatus in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

getNamespace

public GetNamespaceResult getNamespace(GetNamespaceRequest request)

Gets information about a namespace.

Specified by:

getNamespace in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

getOperation

public GetOperationResult getOperation(GetOperationRequest request)

Gets information about any operation that returns an operation ID in the response, such as a CreateHttpNamespace request.

To get a list of operations that match specified criteria, see ListOperations.

Specified by:

getOperation in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

getService

public GetServiceResult getService(GetServiceRequest request)

Gets the settings for a specified service.

Specified by:

getService in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

listInstances

public ListInstancesResult listInstances(ListInstancesRequest request)

Lists summary information about the instances that you registered by using a specified service.

Specified by:

listInstances in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

listNamespaces

public ListNamespacesResult listNamespaces(ListNamespacesRequest request)

Lists summary information about the namespaces that were created by the current Amazon Web Services account.

Specified by:

listNamespaces in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

listOperations

public ListOperationsResult listOperations(ListOperationsRequest request)

Lists operations that match the criteria that you specify.

Specified by:

listOperations in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

listServices

public ListServicesResult listServices(ListServicesRequest request)

Lists summary information for all the services that are associated with one or more namespaces.

Specified by:

listServices in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists tags for the specified resource.

Specified by:

listTagsForResource in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

registerInstance

public RegisterInstanceResult registerInstance(RegisterInstanceRequest request)

Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a RegisterInstance request, the following occurs:

• For each DNS record that you define in the service that'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 RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID.

For more information, see CreateService.

When 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.

Specified by:

registerInstance in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds one or more tags to the specified resource.

Specified by:

tagResource in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes one or more tags from the specified resource.

Specified by:

untagResource in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

updateHttpNamespace

public UpdateHttpNamespaceResult updateHttpNamespace(UpdateHttpNamespaceRequest request)

Updates an HTTP namespace.

Specified by:

updateHttpNamespace in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

updateInstanceCustomHealthStatus

public UpdateInstanceCustomHealthStatusResult updateInstanceCustomHealthStatus(UpdateInstanceCustomHealthStatusRequest request)

Submits a request to change the health status of a custom health check to healthy or unhealthy.

You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig.

For more information, see HealthCheckCustomConfig.

Specified by:

updateInstanceCustomHealthStatus in interface AWSServiceDiscovery

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 by ServiceId and InstanceId isn'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.

See Also:

AWS API Documentation

updatePrivateDnsNamespace

public UpdatePrivateDnsNamespaceResult updatePrivateDnsNamespace(UpdatePrivateDnsNamespaceRequest request)

Updates a private DNS namespace.

Specified by:

updatePrivateDnsNamespace in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

updatePublicDnsNamespace

public UpdatePublicDnsNamespaceResult updatePublicDnsNamespace(UpdatePublicDnsNamespaceRequest request)

Updates a public DNS namespace.

Specified by:

updatePublicDnsNamespace in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

updateService

public UpdateServiceResult updateService(UpdateServiceRequest request)

Submits a request to perform the following operations:

• Update the TTL setting for existing DnsRecords configurations

• Add, update, or delete HealthCheckConfig for a specified service

  You can't add, update, or delete a HealthCheckCustomConfig configuration.

For public and private DNS namespaces, note the following:

• If you omit any existing DnsRecords or HealthCheckConfig configurations from an UpdateService request, the configurations are deleted from the service.

• If you omit an existing HealthCheckCustomConfig configuration from an UpdateService request, 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.

Specified by:

updateService in interface AWSServiceDiscovery

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSServiceDiscovery

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSServiceDiscovery

Overrides:

shutdown in class AmazonWebServiceClient