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.

Amazon Route 53 autonaming lets you configure public or private namespaces that your microservice applications run in. When instances of the service become available, you can call the autonaming API to register the instance, and Amazon Route 53 automatically creates up to five DNS records and an optional health check. Clients that submit DNS queries 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()
CreatePrivateDnsNamespaceResult	createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest request) Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC.
CreatePublicDnsNamespaceResult	createPublicDnsNamespace(CreatePublicDnsNamespaceRequest request) Creates a public namespace based on DNS, which will be visible on the internet.
CreateServiceResult	createService(CreateServiceRequest request) Creates a service, which defines a template for the following entities:
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 resource record sets and the health check, if any, that Amazon Route 53 created for the specified 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 CreateService request.
GetServiceResult	getService(GetServiceRequest request) Gets the settings for a specified service.
ListInstancesResult	listInstances(ListInstancesRequest request) Gets summary information about the instances that you created by using a specified service.
ListNamespacesResult	listNamespaces(ListNamespacesRequest request) Gets information about the namespaces that were created by the current AWS account.
ListOperationsResult	listOperations(ListOperationsRequest request) Lists operations that match the criteria that you specify.
ListServicesResult	listServices(ListServicesRequest request) Gets settings for all the services that are associated with one or more specified namespaces.
RegisterInstanceResult	registerInstance(RegisterInstanceRequest request) Creates one or more resource record sets and optionally a health check based on the settings in a specified service.
UpdateServiceResult	updateService(UpdateServiceRequest request) Updates the TTL setting for a specified service.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

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

Methods inherited from class java.lang.Object

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

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

shutdown

Method Detail

builder

public static AWSServiceDiscoveryClientBuilder builder()

createPrivateDnsNamespace

public CreatePrivateDnsNamespaceResult createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest request)

Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. You can associate more than one service with the same namespace.

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, when you're creating a namespace, the value of Name might not be a valid DNS name.

NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.

ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.

DuplicateRequestException - This request tried to create an object that already exists.

See Also:

AWS API Documentation

createPublicDnsNamespace

public CreatePublicDnsNamespaceResult createPublicDnsNamespace(CreatePublicDnsNamespaceRequest request)

Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. You can associate more than one service with the same namespace.

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, when you're creating a namespace, the value of Name might not be a valid DNS name.

NamespaceAlreadyExistsException - The namespace that you're trying to create already exists.

ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.

DuplicateRequestException - This request tried to create an object that already exists.

See Also:

AWS API Documentation

createService

public CreateServiceResult createService(CreateServiceRequest request)

Creates a service, which defines a template for the following entities:

• One to five resource record sets

• Optionally, a health check

After you create the service, you can submit a RegisterInstance request, and Amazon Route 53 uses the values in the template to create the specified entities.

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, when you're creating a namespace, the value of Name might not be a valid DNS name.

ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.

NamespaceNotFoundException - No namespace exists with the specified ID.

ServiceAlreadyExistsException - The service can't be created because a service with the same name already exists.

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, when you're creating a namespace, the value of Name might not be a valid DNS name.

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 - This request tried to create an object that already exists.

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, when you're creating a namespace, the value of Name might not be a valid DNS name.

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 resource record sets and the health check, if any, that Amazon Route 53 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 - This request tried to create an object that already exists.

InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

InstanceNotFoundException - No instance 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.

ServiceNotFoundException - No service exists with the specified ID.

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.

InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

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.

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.

InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

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, when you're creating a namespace, the value of Name might not be a valid DNS name.

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 CreateService 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:

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, when you're creating a namespace, the value of Name might not be a valid DNS name.

ServiceNotFoundException - No service exists with the specified ID.

See Also:

AWS API Documentation

listInstances

public ListInstancesResult listInstances(ListInstancesRequest request)

Gets summary information about the instances that you created 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, when you're creating a namespace, the value of Name might not be a valid DNS name.

See Also:

AWS API Documentation

listNamespaces

public ListNamespacesResult listNamespaces(ListNamespacesRequest request)

Gets information about the namespaces that were created by the current AWS 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, when you're creating a namespace, the value of Name might not be a valid DNS name.

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, when you're creating a namespace, the value of Name might not be a valid DNS name.

See Also:

AWS API Documentation

listServices

public ListServicesResult listServices(ListServicesRequest request)

Gets settings for all the services that are associated with one or more specified namespaces.

Specified by:

listServices in interface AWSServiceDiscovery

Parameters:

listServicesRequest -

Returns:

Result of the ListServices operation returned by the service.

See Also:

AWS API Documentation

registerInstance

public RegisterInstanceResult registerInstance(RegisterInstanceRequest request)

Creates one or more resource record sets and optionally a health check based on the settings in a specified service. When you submit a RegisterInstance request, Amazon Route 53 does the following:

• Creates a resource record set for each resource record set template in the service

• Creates a health check based on the settings in the health check template in the service, if any

• Associates the health check, if any, with each of the resource record sets

One RegisterInstance request must complete before you can submit another request and specify the same service and instance ID.

For more information, see CreateService.

When Amazon Route 53 receives a DNS query for the specified DNS name, it returns the applicable value:

• If the health check is healthy: returns all the resource record sets

• If the health check is unhealthy: returns the IP address of the last healthy instance

• If you didn't specify a health check template: returns all the resource record sets

Specified by:

registerInstance in interface AWSServiceDiscovery

Parameters:

registerInstanceRequest -

Returns:

Result of the RegisterInstance operation returned by the service.

Throws:

DuplicateRequestException - This request tried to create an object that already exists.

InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

ResourceInUseException - The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.

ResourceLimitExceededException - The resource can't be created because you've reached the limit on the number of resources.

ServiceNotFoundException - No service exists with the specified ID.

See Also:

AWS API Documentation

updateService

public UpdateServiceResult updateService(UpdateServiceRequest request)

Updates the TTL setting for a specified service. You must specify all the resource record set templates (and, optionally, a health check template) that you want to appear in the updated service. Any current resource record set templates (or health check template) that don't appear in an UpdateService request are deleted.

When you update the TTL setting for a service, Amazon Route 53 also updates the corresponding settings in all the resource record sets 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 - This request tried to create an object that already exists.

InvalidInputException - One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

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.