AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ServiceDiscovery

import "github.com/aws/aws-sdk-go/service/servicediscovery"

type ServiceDiscovery struct { *client.Client }

ServiceDiscovery provides the API operation methods for making requests to AWS Cloud Map. See this package's package overview docs for details on the service.

ServiceDiscovery methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

Client

Type: *client.Client

Method

CreateHttpNamespace

func (c *ServiceDiscovery) CreateHttpNamespace(input *CreateHttpNamespaceInput) (*CreateHttpNamespaceOutput, error)

CreateHttpNamespace API operation for AWS Cloud Map.

Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.

For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the AWS Cloud Map Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation CreateHttpNamespace for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeNamespaceAlreadyExists "NamespaceAlreadyExists" The namespace that you're trying to create already exists.

  • ErrCodeResourceLimitExceeded "ResourceLimitExceeded" The resource can't be created because you've reached the limit on the number of resources.

  • ErrCodeDuplicateRequest "DuplicateRequest" The operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateHttpNamespace

CreateHttpNamespaceRequest

func (c *ServiceDiscovery) CreateHttpNamespaceRequest(input *CreateHttpNamespaceInput) (req *request.Request, output *CreateHttpNamespaceOutput)

CreateHttpNamespaceRequest generates a "aws/request.Request" representing the client's request for the CreateHttpNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateHttpNamespace for more information on using the CreateHttpNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateHttpNamespaceRequest method. req, resp := client.CreateHttpNamespaceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateHttpNamespace

CreateHttpNamespaceWithContext

func (c *ServiceDiscovery) CreateHttpNamespaceWithContext(ctx aws.Context, input *CreateHttpNamespaceInput, opts ...request.Option) (*CreateHttpNamespaceOutput, error)

CreateHttpNamespaceWithContext is the same as CreateHttpNamespace with the addition of the ability to pass a context and additional request options.

See CreateHttpNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreatePrivateDnsNamespace

func (c *ServiceDiscovery) CreatePrivateDnsNamespace(input *CreatePrivateDnsNamespaceInput) (*CreatePrivateDnsNamespaceOutput, error)

CreatePrivateDnsNamespace API operation for AWS Cloud Map.

Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the AWS Cloud Map Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation CreatePrivateDnsNamespace for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeNamespaceAlreadyExists "NamespaceAlreadyExists" The namespace that you're trying to create already exists.

  • ErrCodeResourceLimitExceeded "ResourceLimitExceeded" The resource can't be created because you've reached the limit on the number of resources.

  • ErrCodeDuplicateRequest "DuplicateRequest" The operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePrivateDnsNamespace

CreatePrivateDnsNamespaceRequest

func (c *ServiceDiscovery) CreatePrivateDnsNamespaceRequest(input *CreatePrivateDnsNamespaceInput) (req *request.Request, output *CreatePrivateDnsNamespaceOutput)

CreatePrivateDnsNamespaceRequest generates a "aws/request.Request" representing the client's request for the CreatePrivateDnsNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePrivateDnsNamespace for more information on using the CreatePrivateDnsNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreatePrivateDnsNamespaceRequest method. req, resp := client.CreatePrivateDnsNamespaceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePrivateDnsNamespace

CreatePrivateDnsNamespaceWithContext

func (c *ServiceDiscovery) CreatePrivateDnsNamespaceWithContext(ctx aws.Context, input *CreatePrivateDnsNamespaceInput, opts ...request.Option) (*CreatePrivateDnsNamespaceOutput, error)

CreatePrivateDnsNamespaceWithContext is the same as CreatePrivateDnsNamespace with the addition of the ability to pass a context and additional request options.

See CreatePrivateDnsNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreatePublicDnsNamespace

func (c *ServiceDiscovery) CreatePublicDnsNamespace(input *CreatePublicDnsNamespaceInput) (*CreatePublicDnsNamespaceOutput, error)

CreatePublicDnsNamespace API operation for AWS Cloud Map.

Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the AWS Cloud Map Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation CreatePublicDnsNamespace for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeNamespaceAlreadyExists "NamespaceAlreadyExists" The namespace that you're trying to create already exists.

  • ErrCodeResourceLimitExceeded "ResourceLimitExceeded" The resource can't be created because you've reached the limit on the number of resources.

  • ErrCodeDuplicateRequest "DuplicateRequest" The operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePublicDnsNamespace

CreatePublicDnsNamespaceRequest

func (c *ServiceDiscovery) CreatePublicDnsNamespaceRequest(input *CreatePublicDnsNamespaceInput) (req *request.Request, output *CreatePublicDnsNamespaceOutput)

CreatePublicDnsNamespaceRequest generates a "aws/request.Request" representing the client's request for the CreatePublicDnsNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePublicDnsNamespace for more information on using the CreatePublicDnsNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreatePublicDnsNamespaceRequest method. req, resp := client.CreatePublicDnsNamespaceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreatePublicDnsNamespace

CreatePublicDnsNamespaceWithContext

func (c *ServiceDiscovery) CreatePublicDnsNamespaceWithContext(ctx aws.Context, input *CreatePublicDnsNamespaceInput, opts ...request.Option) (*CreatePublicDnsNamespaceOutput, error)

CreatePublicDnsNamespaceWithContext is the same as CreatePublicDnsNamespace with the addition of the ability to pass a context and additional request options.

See CreatePublicDnsNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

CreateService

func (c *ServiceDiscovery) CreateService(input *CreateServiceInput) (*CreateServiceOutput, error)

CreateService API operation for AWS Cloud Map.

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

  • For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:

A

AAAA

A and AAAA

SRV

CNAME

  • Optionally, a health check

After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities.

For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the AWS Cloud Map Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation CreateService for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeResourceLimitExceeded "ResourceLimitExceeded" The resource can't be created because you've reached the limit on the number of resources.

  • ErrCodeNamespaceNotFound "NamespaceNotFound" No namespace exists with the specified ID.

  • ErrCodeServiceAlreadyExists "ServiceAlreadyExists" The service can't be created because a service with the same name already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateService

CreateServiceRequest

func (c *ServiceDiscovery) CreateServiceRequest(input *CreateServiceInput) (req *request.Request, output *CreateServiceOutput)

CreateServiceRequest generates a "aws/request.Request" representing the client's request for the CreateService operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateService for more information on using the CreateService API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateServiceRequest method. req, resp := client.CreateServiceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/CreateService

CreateServiceWithContext

func (c *ServiceDiscovery) CreateServiceWithContext(ctx aws.Context, input *CreateServiceInput, opts ...request.Option) (*CreateServiceOutput, error)

CreateServiceWithContext is the same as CreateService with the addition of the ability to pass a context and additional request options.

See CreateService for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteNamespace

func (c *ServiceDiscovery) DeleteNamespace(input *DeleteNamespaceInput) (*DeleteNamespaceOutput, error)

DeleteNamespace API operation for AWS Cloud Map.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation DeleteNamespace for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeNamespaceNotFound "NamespaceNotFound" No namespace exists with the specified ID.

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

  • ErrCodeDuplicateRequest "DuplicateRequest" The operation is already in progress.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteNamespace

DeleteNamespaceRequest

func (c *ServiceDiscovery) DeleteNamespaceRequest(input *DeleteNamespaceInput) (req *request.Request, output *DeleteNamespaceOutput)

DeleteNamespaceRequest generates a "aws/request.Request" representing the client's request for the DeleteNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteNamespace for more information on using the DeleteNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteNamespaceRequest method. req, resp := client.DeleteNamespaceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteNamespace

DeleteNamespaceWithContext

func (c *ServiceDiscovery) DeleteNamespaceWithContext(ctx aws.Context, input *DeleteNamespaceInput, opts ...request.Option) (*DeleteNamespaceOutput, error)

DeleteNamespaceWithContext is the same as DeleteNamespace with the addition of the ability to pass a context and additional request options.

See DeleteNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeleteService

func (c *ServiceDiscovery) DeleteService(input *DeleteServiceInput) (*DeleteServiceOutput, error)

DeleteService API operation for AWS Cloud Map.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation DeleteService for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeServiceNotFound "ServiceNotFound" No service exists with the specified ID.

  • ErrCodeResourceInUse "ResourceInUse" 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, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteService

DeleteServiceRequest

func (c *ServiceDiscovery) DeleteServiceRequest(input *DeleteServiceInput) (req *request.Request, output *DeleteServiceOutput)

DeleteServiceRequest generates a "aws/request.Request" representing the client's request for the DeleteService operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteService for more information on using the DeleteService API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteServiceRequest method. req, resp := client.DeleteServiceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeleteService

DeleteServiceWithContext

func (c *ServiceDiscovery) DeleteServiceWithContext(ctx aws.Context, input *DeleteServiceInput, opts ...request.Option) (*DeleteServiceOutput, error)

DeleteServiceWithContext is the same as DeleteService with the addition of the ability to pass a context and additional request options.

See DeleteService for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DeregisterInstance

func (c *ServiceDiscovery) DeregisterInstance(input *DeregisterInstanceInput) (*DeregisterInstanceOutput, error)

DeregisterInstance API operation for AWS Cloud Map.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation DeregisterInstance for usage and error information.

Returned Error Codes:

  • ErrCodeDuplicateRequest "DuplicateRequest" The operation is already in progress.

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeInstanceNotFound "InstanceNotFound" No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.

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

  • ErrCodeServiceNotFound "ServiceNotFound" No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeregisterInstance

DeregisterInstanceRequest

func (c *ServiceDiscovery) DeregisterInstanceRequest(input *DeregisterInstanceInput) (req *request.Request, output *DeregisterInstanceOutput)

DeregisterInstanceRequest generates a "aws/request.Request" representing the client's request for the DeregisterInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeregisterInstance for more information on using the DeregisterInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeregisterInstanceRequest method. req, resp := client.DeregisterInstanceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DeregisterInstance

DeregisterInstanceWithContext

func (c *ServiceDiscovery) DeregisterInstanceWithContext(ctx aws.Context, input *DeregisterInstanceInput, opts ...request.Option) (*DeregisterInstanceOutput, error)

DeregisterInstanceWithContext is the same as DeregisterInstance with the addition of the ability to pass a context and additional request options.

See DeregisterInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

DiscoverInstances

func (c *ServiceDiscovery) DiscoverInstances(input *DiscoverInstancesInput) (*DiscoverInstancesOutput, error)

DiscoverInstances API operation for AWS Cloud Map.

Discovers registered instances for a specified namespace and service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation DiscoverInstances for usage and error information.

Returned Error Codes:

  • ErrCodeServiceNotFound "ServiceNotFound" No service exists with the specified ID.

  • ErrCodeNamespaceNotFound "NamespaceNotFound" No namespace exists with the specified ID.

  • ErrCodeInvalidInput "InvalidInput" 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, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DiscoverInstances

DiscoverInstancesRequest

func (c *ServiceDiscovery) DiscoverInstancesRequest(input *DiscoverInstancesInput) (req *request.Request, output *DiscoverInstancesOutput)

DiscoverInstancesRequest generates a "aws/request.Request" representing the client's request for the DiscoverInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DiscoverInstances for more information on using the DiscoverInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DiscoverInstancesRequest method. req, resp := client.DiscoverInstancesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/DiscoverInstances

DiscoverInstancesWithContext

func (c *ServiceDiscovery) DiscoverInstancesWithContext(ctx aws.Context, input *DiscoverInstancesInput, opts ...request.Option) (*DiscoverInstancesOutput, error)

DiscoverInstancesWithContext is the same as DiscoverInstances with the addition of the ability to pass a context and additional request options.

See DiscoverInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetInstance

func (c *ServiceDiscovery) GetInstance(input *GetInstanceInput) (*GetInstanceOutput, error)

GetInstance API operation for AWS Cloud Map.

Gets information about a specified instance.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation GetInstance for usage and error information.

Returned Error Codes:

  • ErrCodeInstanceNotFound "InstanceNotFound" No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeServiceNotFound "ServiceNotFound" No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstance

GetInstanceRequest

func (c *ServiceDiscovery) GetInstanceRequest(input *GetInstanceInput) (req *request.Request, output *GetInstanceOutput)

GetInstanceRequest generates a "aws/request.Request" representing the client's request for the GetInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstance for more information on using the GetInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstanceRequest method. req, resp := client.GetInstanceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstance

GetInstanceWithContext

func (c *ServiceDiscovery) GetInstanceWithContext(ctx aws.Context, input *GetInstanceInput, opts ...request.Option) (*GetInstanceOutput, error)

GetInstanceWithContext is the same as GetInstance with the addition of the ability to pass a context and additional request options.

See GetInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetInstancesHealthStatus

func (c *ServiceDiscovery) GetInstancesHealthStatus(input *GetInstancesHealthStatusInput) (*GetInstancesHealthStatusOutput, error)

GetInstancesHealthStatus API operation for AWS Cloud Map.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation GetInstancesHealthStatus for usage and error information.

Returned Error Codes:

  • ErrCodeInstanceNotFound "InstanceNotFound" No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeServiceNotFound "ServiceNotFound" No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstancesHealthStatus

GetInstancesHealthStatusPages

func (c *ServiceDiscovery) GetInstancesHealthStatusPages(input *GetInstancesHealthStatusInput, fn func(*GetInstancesHealthStatusOutput, bool) bool) error

GetInstancesHealthStatusPages iterates over the pages of a GetInstancesHealthStatus operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetInstancesHealthStatus method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetInstancesHealthStatus operation. pageNum := 0 err := client.GetInstancesHealthStatusPages(params, func(page *GetInstancesHealthStatusOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

GetInstancesHealthStatusPagesWithContext

func (c *ServiceDiscovery) GetInstancesHealthStatusPagesWithContext(ctx aws.Context, input *GetInstancesHealthStatusInput, fn func(*GetInstancesHealthStatusOutput, bool) bool, opts ...request.Option) error

GetInstancesHealthStatusPagesWithContext same as GetInstancesHealthStatusPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetInstancesHealthStatusRequest

func (c *ServiceDiscovery) GetInstancesHealthStatusRequest(input *GetInstancesHealthStatusInput) (req *request.Request, output *GetInstancesHealthStatusOutput)

GetInstancesHealthStatusRequest generates a "aws/request.Request" representing the client's request for the GetInstancesHealthStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInstancesHealthStatus for more information on using the GetInstancesHealthStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetInstancesHealthStatusRequest method. req, resp := client.GetInstancesHealthStatusRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstancesHealthStatus

GetInstancesHealthStatusWithContext

func (c *ServiceDiscovery) GetInstancesHealthStatusWithContext(ctx aws.Context, input *GetInstancesHealthStatusInput, opts ...request.Option) (*GetInstancesHealthStatusOutput, error)

GetInstancesHealthStatusWithContext is the same as GetInstancesHealthStatus with the addition of the ability to pass a context and additional request options.

See GetInstancesHealthStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetNamespace

func (c *ServiceDiscovery) GetNamespace(input *GetNamespaceInput) (*GetNamespaceOutput, error)

GetNamespace API operation for AWS Cloud Map.

Gets information about a namespace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation GetNamespace for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeNamespaceNotFound "NamespaceNotFound" No namespace exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetNamespace

GetNamespaceRequest

func (c *ServiceDiscovery) GetNamespaceRequest(input *GetNamespaceInput) (req *request.Request, output *GetNamespaceOutput)

GetNamespaceRequest generates a "aws/request.Request" representing the client's request for the GetNamespace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetNamespace for more information on using the GetNamespace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetNamespaceRequest method. req, resp := client.GetNamespaceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetNamespace

GetNamespaceWithContext

func (c *ServiceDiscovery) GetNamespaceWithContext(ctx aws.Context, input *GetNamespaceInput, opts ...request.Option) (*GetNamespaceOutput, error)

GetNamespaceWithContext is the same as GetNamespace with the addition of the ability to pass a context and additional request options.

See GetNamespace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetOperation

func (c *ServiceDiscovery) GetOperation(input *GetOperationInput) (*GetOperationOutput, error)

GetOperation API operation for AWS Cloud Map.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation GetOperation for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeOperationNotFound "OperationNotFound" No operation exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetOperation

GetOperationRequest

func (c *ServiceDiscovery) GetOperationRequest(input *GetOperationInput) (req *request.Request, output *GetOperationOutput)

GetOperationRequest generates a "aws/request.Request" representing the client's request for the GetOperation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetOperation for more information on using the GetOperation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetOperationRequest method. req, resp := client.GetOperationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetOperation

GetOperationWithContext

func (c *ServiceDiscovery) GetOperationWithContext(ctx aws.Context, input *GetOperationInput, opts ...request.Option) (*GetOperationOutput, error)

GetOperationWithContext is the same as GetOperation with the addition of the ability to pass a context and additional request options.

See GetOperation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

GetService

func (c *ServiceDiscovery) GetService(input *GetServiceInput) (*GetServiceOutput, error)

GetService API operation for AWS Cloud Map.

Gets the settings for a specified service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation GetService for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeServiceNotFound "ServiceNotFound" No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetService

GetServiceRequest

func (c *ServiceDiscovery) GetServiceRequest(input *GetServiceInput) (req *request.Request, output *GetServiceOutput)

GetServiceRequest generates a "aws/request.Request" representing the client's request for the GetService operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetService for more information on using the GetService API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetServiceRequest method. req, resp := client.GetServiceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetService

GetServiceWithContext

func (c *ServiceDiscovery) GetServiceWithContext(ctx aws.Context, input *GetServiceInput, opts ...request.Option) (*GetServiceOutput, error)

GetServiceWithContext is the same as GetService with the addition of the ability to pass a context and additional request options.

See GetService for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListInstances

func (c *ServiceDiscovery) ListInstances(input *ListInstancesInput) (*ListInstancesOutput, error)

ListInstances API operation for AWS Cloud Map.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation ListInstances for usage and error information.

Returned Error Codes:

  • ErrCodeServiceNotFound "ServiceNotFound" No service exists with the specified ID.

  • ErrCodeInvalidInput "InvalidInput" 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, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListInstances

ListInstancesPages

func (c *ServiceDiscovery) ListInstancesPages(input *ListInstancesInput, fn func(*ListInstancesOutput, bool) bool) error

ListInstancesPages iterates over the pages of a ListInstances operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListInstances method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListInstances operation. pageNum := 0 err := client.ListInstancesPages(params, func(page *ListInstancesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

ListInstancesPagesWithContext

func (c *ServiceDiscovery) ListInstancesPagesWithContext(ctx aws.Context, input *ListInstancesInput, fn func(*ListInstancesOutput, bool) bool, opts ...request.Option) error

ListInstancesPagesWithContext same as ListInstancesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListInstancesRequest

func (c *ServiceDiscovery) ListInstancesRequest(input *ListInstancesInput) (req *request.Request, output *ListInstancesOutput)

ListInstancesRequest generates a "aws/request.Request" representing the client's request for the ListInstances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListInstances for more information on using the ListInstances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListInstancesRequest method. req, resp := client.ListInstancesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListInstances

ListInstancesWithContext

func (c *ServiceDiscovery) ListInstancesWithContext(ctx aws.Context, input *ListInstancesInput, opts ...request.Option) (*ListInstancesOutput, error)

ListInstancesWithContext is the same as ListInstances with the addition of the ability to pass a context and additional request options.

See ListInstances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListNamespaces

func (c *ServiceDiscovery) ListNamespaces(input *ListNamespacesInput) (*ListNamespacesOutput, error)

ListNamespaces API operation for AWS Cloud Map.

Lists summary information about the namespaces that were created by the current AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation ListNamespaces for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListNamespaces

ListNamespacesPages

func (c *ServiceDiscovery) ListNamespacesPages(input *ListNamespacesInput, fn func(*ListNamespacesOutput, bool) bool) error

ListNamespacesPages iterates over the pages of a ListNamespaces operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListNamespaces method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListNamespaces operation. pageNum := 0 err := client.ListNamespacesPages(params, func(page *ListNamespacesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

ListNamespacesPagesWithContext

func (c *ServiceDiscovery) ListNamespacesPagesWithContext(ctx aws.Context, input *ListNamespacesInput, fn func(*ListNamespacesOutput, bool) bool, opts ...request.Option) error

ListNamespacesPagesWithContext same as ListNamespacesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListNamespacesRequest

func (c *ServiceDiscovery) ListNamespacesRequest(input *ListNamespacesInput) (req *request.Request, output *ListNamespacesOutput)

ListNamespacesRequest generates a "aws/request.Request" representing the client's request for the ListNamespaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListNamespaces for more information on using the ListNamespaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListNamespacesRequest method. req, resp := client.ListNamespacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListNamespaces

ListNamespacesWithContext

func (c *ServiceDiscovery) ListNamespacesWithContext(ctx aws.Context, input *ListNamespacesInput, opts ...request.Option) (*ListNamespacesOutput, error)

ListNamespacesWithContext is the same as ListNamespaces with the addition of the ability to pass a context and additional request options.

See ListNamespaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListOperations

func (c *ServiceDiscovery) ListOperations(input *ListOperationsInput) (*ListOperationsOutput, error)

ListOperations API operation for AWS Cloud Map.

Lists operations that match the criteria that you specify.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation ListOperations for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListOperations

ListOperationsPages

func (c *ServiceDiscovery) ListOperationsPages(input *ListOperationsInput, fn func(*ListOperationsOutput, bool) bool) error

ListOperationsPages iterates over the pages of a ListOperations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListOperations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListOperations operation. pageNum := 0 err := client.ListOperationsPages(params, func(page *ListOperationsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

ListOperationsPagesWithContext

func (c *ServiceDiscovery) ListOperationsPagesWithContext(ctx aws.Context, input *ListOperationsInput, fn func(*ListOperationsOutput, bool) bool, opts ...request.Option) error

ListOperationsPagesWithContext same as ListOperationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListOperationsRequest

func (c *ServiceDiscovery) ListOperationsRequest(input *ListOperationsInput) (req *request.Request, output *ListOperationsOutput)

ListOperationsRequest generates a "aws/request.Request" representing the client's request for the ListOperations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListOperations for more information on using the ListOperations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListOperationsRequest method. req, resp := client.ListOperationsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListOperations

ListOperationsWithContext

func (c *ServiceDiscovery) ListOperationsWithContext(ctx aws.Context, input *ListOperationsInput, opts ...request.Option) (*ListOperationsOutput, error)

ListOperationsWithContext is the same as ListOperations with the addition of the ability to pass a context and additional request options.

See ListOperations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListServices

func (c *ServiceDiscovery) ListServices(input *ListServicesInput) (*ListServicesOutput, error)

ListServices API operation for AWS Cloud Map.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation ListServices for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidInput "InvalidInput" 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, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListServices

ListServicesPages

func (c *ServiceDiscovery) ListServicesPages(input *ListServicesInput, fn func(*ListServicesOutput, bool) bool) error

ListServicesPages iterates over the pages of a ListServices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListServices method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListServices operation. pageNum := 0 err := client.ListServicesPages(params, func(page *ListServicesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })

See Also

For more information about using this API, see AWS API Documentation.

ListServicesPagesWithContext

func (c *ServiceDiscovery) ListServicesPagesWithContext(ctx aws.Context, input *ListServicesInput, fn func(*ListServicesOutput, bool) bool, opts ...request.Option) error

ListServicesPagesWithContext same as ListServicesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

ListServicesRequest

func (c *ServiceDiscovery) ListServicesRequest(input *ListServicesInput) (req *request.Request, output *ListServicesOutput)

ListServicesRequest generates a "aws/request.Request" representing the client's request for the ListServices operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListServices for more information on using the ListServices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListServicesRequest method. req, resp := client.ListServicesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/ListServices

ListServicesWithContext

func (c *ServiceDiscovery) ListServicesWithContext(ctx aws.Context, input *ListServicesInput, opts ...request.Option) (*ListServicesOutput, error)

ListServicesWithContext is the same as ListServices with the addition of the ability to pass a context and additional request options.

See ListServices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

RegisterInstance

func (c *ServiceDiscovery) RegisterInstance(input *RegisterInstanceInput) (*RegisterInstanceOutput, error)

RegisterInstance API operation for AWS Cloud Map.

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

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

  • If the service includes HealthCheckConfig, a health check is created based on the settings in the health check configuration.

  • The health check, if any, is associated with each of the new or updated records.

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

For more information, see CreateService.

When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:

  • If the health check is healthy: returns all the records

  • If the health check is unhealthy: returns the applicable value for the last healthy instance

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

For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits (https://docs.aws.amazon.com/cloud-map/latest/dg/cloud-map-limits.html) in the AWS Cloud Map Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation RegisterInstance for usage and error information.

Returned Error Codes:

  • ErrCodeDuplicateRequest "DuplicateRequest" The operation is already in progress.

  • ErrCodeInvalidInput "InvalidInput" 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.

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

  • ErrCodeResourceLimitExceeded "ResourceLimitExceeded" The resource can't be created because you've reached the limit on the number of resources.

  • ErrCodeServiceNotFound "ServiceNotFound" No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/RegisterInstance

RegisterInstanceRequest

func (c *ServiceDiscovery) RegisterInstanceRequest(input *RegisterInstanceInput) (req *request.Request, output *RegisterInstanceOutput)

RegisterInstanceRequest generates a "aws/request.Request" representing the client's request for the RegisterInstance operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterInstance for more information on using the RegisterInstance API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RegisterInstanceRequest method. req, resp := client.RegisterInstanceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/RegisterInstance

RegisterInstanceWithContext

func (c *ServiceDiscovery) RegisterInstanceWithContext(ctx aws.Context, input *RegisterInstanceInput, opts ...request.Option) (*RegisterInstanceOutput, error)

RegisterInstanceWithContext is the same as RegisterInstance with the addition of the ability to pass a context and additional request options.

See RegisterInstance for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateInstanceCustomHealthStatus

func (c *ServiceDiscovery) UpdateInstanceCustomHealthStatus(input *UpdateInstanceCustomHealthStatusInput) (*UpdateInstanceCustomHealthStatusOutput, error)

UpdateInstanceCustomHealthStatus API operation for AWS Cloud Map.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation UpdateInstanceCustomHealthStatus for usage and error information.

Returned Error Codes:

  • ErrCodeInstanceNotFound "InstanceNotFound" No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.

  • ErrCodeServiceNotFound "ServiceNotFound" No service exists with the specified ID.

  • ErrCodeCustomHealthNotFound "CustomHealthNotFound" The health check for the instance that is specified by ServiceId and InstanceId is not a custom health check.

  • ErrCodeInvalidInput "InvalidInput" 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, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateInstanceCustomHealthStatus

UpdateInstanceCustomHealthStatusRequest

func (c *ServiceDiscovery) UpdateInstanceCustomHealthStatusRequest(input *UpdateInstanceCustomHealthStatusInput) (req *request.Request, output *UpdateInstanceCustomHealthStatusOutput)

UpdateInstanceCustomHealthStatusRequest generates a "aws/request.Request" representing the client's request for the UpdateInstanceCustomHealthStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateInstanceCustomHealthStatus for more information on using the UpdateInstanceCustomHealthStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateInstanceCustomHealthStatusRequest method. req, resp := client.UpdateInstanceCustomHealthStatusRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateInstanceCustomHealthStatus

UpdateInstanceCustomHealthStatusWithContext

func (c *ServiceDiscovery) UpdateInstanceCustomHealthStatusWithContext(ctx aws.Context, input *UpdateInstanceCustomHealthStatusInput, opts ...request.Option) (*UpdateInstanceCustomHealthStatusOutput, error)

UpdateInstanceCustomHealthStatusWithContext is the same as UpdateInstanceCustomHealthStatus with the addition of the ability to pass a context and additional request options.

See UpdateInstanceCustomHealthStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

UpdateService

func (c *ServiceDiscovery) UpdateService(input *UpdateServiceInput) (*UpdateServiceOutput, error)

UpdateService API operation for AWS Cloud Map.

Submits a request to perform the following operations:

  • Add or delete DnsRecords configurations

  • Update the TTL setting for existing DnsRecords configurations

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

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

When you update the TTL setting for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Cloud Map's API operation UpdateService for usage and error information.

Returned Error Codes:

  • ErrCodeDuplicateRequest "DuplicateRequest" The operation is already in progress.

  • ErrCodeInvalidInput "InvalidInput" 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.

  • ErrCodeServiceNotFound "ServiceNotFound" No service exists with the specified ID.

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateService

UpdateServiceRequest

func (c *ServiceDiscovery) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Request, output *UpdateServiceOutput)

UpdateServiceRequest generates a "aws/request.Request" representing the client's request for the UpdateService operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateService for more information on using the UpdateService API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateServiceRequest method. req, resp := client.UpdateServiceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

See also, https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/UpdateService

UpdateServiceWithContext

func (c *ServiceDiscovery) UpdateServiceWithContext(ctx aws.Context, input *UpdateServiceInput, opts ...request.Option) (*UpdateServiceOutput, error)

UpdateServiceWithContext is the same as UpdateService with the addition of the ability to pass a context and additional request options.

See UpdateService for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

See Also

For more information about using this API, see AWS API Documentation.

On this page: