com.amazonaws.services.servicediscovery

Interface AWSServiceDiscovery

All Known Subinterfaces:

AWSServiceDiscoveryAsync

All Known Implementing Classes:

AbstractAWSServiceDiscovery, AbstractAWSServiceDiscoveryAsync, AWSServiceDiscoveryAsyncClient, AWSServiceDiscoveryClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSServiceDiscovery

Interface for accessing ServiceDiscovery.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSServiceDiscovery instead.

Amazon Route 53 auto naming lets you configure public or private namespaces that your microservice applications run in. When instances of the service become available, you can call the auto naming API to register the instance, and 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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreatePrivateDnsNamespaceResult	createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest createPrivateDnsNamespaceRequest) Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC.
CreatePublicDnsNamespaceResult	createPublicDnsNamespace(CreatePublicDnsNamespaceRequest createPublicDnsNamespaceRequest) Creates a public namespace based on DNS, which will be visible on the internet.
CreateServiceResult	createService(CreateServiceRequest createServiceRequest) Creates a service, which defines the configuration for the following entities:
DeleteNamespaceResult	deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest) Deletes a namespace from the current account.
DeleteServiceResult	deleteService(DeleteServiceRequest deleteServiceRequest) Deletes a specified service.
DeregisterInstanceResult	deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest) Deletes the records 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 getInstanceRequest) Gets information about a specified instance.
GetInstancesHealthStatusResult	getInstancesHealthStatus(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest) Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.
GetNamespaceResult	getNamespace(GetNamespaceRequest getNamespaceRequest) Gets information about a namespace.
GetOperationResult	getOperation(GetOperationRequest getOperationRequest) Gets information about any operation that returns an operation ID in the response, such as a CreateService request.
GetServiceResult	getService(GetServiceRequest getServiceRequest) Gets the settings for a specified service.
ListInstancesResult	listInstances(ListInstancesRequest listInstancesRequest) Lists summary information about the instances that you registered by using a specified service.
ListNamespacesResult	listNamespaces(ListNamespacesRequest listNamespacesRequest) Lists summary information about the namespaces that were created by the current AWS account.
ListOperationsResult	listOperations(ListOperationsRequest listOperationsRequest) Lists operations that match the criteria that you specify.
ListServicesResult	listServices(ListServicesRequest listServicesRequest) Lists summary information for all the services that are associated with one or more specified namespaces.
RegisterInstanceResult	registerInstance(RegisterInstanceRequest registerInstanceRequest) Creates or updates one or more records and optionally 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.
UpdateServiceResult	updateService(UpdateServiceRequest updateServiceRequest) Submits a request to perform the following operations:

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createPrivateDnsNamespace

CreatePrivateDnsNamespaceResult createPrivateDnsNamespace(CreatePrivateDnsNamespaceRequest createPrivateDnsNamespaceRequest)

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.

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 - The operation is already in progress.

See Also:

AWS API Documentation

createPublicDnsNamespace

CreatePublicDnsNamespaceResult createPublicDnsNamespace(CreatePublicDnsNamespaceRequest createPublicDnsNamespaceRequest)

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.

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 - The operation is already in progress.

See Also:

AWS API Documentation

createService

CreateServiceResult createService(CreateServiceRequest createServiceRequest)

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

• Up to three records (A, AAAA, and SRV) or one CNAME record

• Optionally, a health check

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

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

DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest deleteNamespaceRequest)

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, 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 - The operation is already in progress.

See Also:

AWS API Documentation

deleteService

DeleteServiceResult deleteService(DeleteServiceRequest deleteServiceRequest)

Deletes a specified service. 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, 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

DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest deregisterInstanceRequest)

Deletes the records and the health check, if any, that Amazon Route 53 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, 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, 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

getInstance

GetInstanceResult getInstance(GetInstanceRequest getInstanceRequest)

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, 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

GetInstancesHealthStatusResult getInstancesHealthStatus(GetInstancesHealthStatusRequest getInstancesHealthStatusRequest)

Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

There is a brief delay between when you register an instance and when the health status for the instance is available.

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, 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

GetNamespaceResult getNamespace(GetNamespaceRequest getNamespaceRequest)

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, 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

GetOperationResult getOperation(GetOperationRequest getOperationRequest)

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.

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

GetServiceResult getService(GetServiceRequest getServiceRequest)

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, 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

ListInstancesResult listInstances(ListInstancesRequest listInstancesRequest)

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

See Also:

AWS API Documentation

listNamespaces

ListNamespacesResult listNamespaces(ListNamespacesRequest listNamespacesRequest)

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

See Also:

AWS API Documentation

listOperations

ListOperationsResult listOperations(ListOperationsRequest listOperationsRequest)

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

See Also:

AWS API Documentation

listServices

ListServicesResult listServices(ListServicesRequest listServicesRequest)

Lists summary information for all the services that are associated with one or more specified 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, when you're creating a namespace, the value of Name might not be a valid DNS name.

See Also:

AWS API Documentation

registerInstance

RegisterInstanceResult registerInstance(RegisterInstanceRequest registerInstanceRequest)

Creates or updates one or more records 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:

• For each DNS record that you define in the service specified by ServiceId, creates or updates a record in the hosted zone that is associated with the corresponding namespace

• Creates or updates a health check based on the settings in the health check configuration, if any, for the service

• Associates the health check, if any, with each of the 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 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 records

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

• If you didn't specify a health check configuration: returns all the records

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, 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

UpdateServiceResult updateService(UpdateServiceRequest updateServiceRequest)

Submits a request to perform the following operations:

• Add or delete DnsRecords configurations

• Update the TTL setting for existing DnsRecords configurations

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

You must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service. Any current configurations that don't appear in an UpdateService request are deleted.

When you update the TTL setting for a service, Amazon Route 53 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, 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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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