servicediscovery

package
v1.38.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 24, 2021 License: Apache-2.0 Imports: 10 Imported by: 184

Documentation

Overview

Package servicediscovery provides the client and types for making API requests to AWS Cloud Map.

AWS Cloud Map lets you configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance of the service becomes available, you can call the AWS Cloud Map API to register the instance with AWS Cloud Map. For public or private DNS namespaces, AWS Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.

See https://docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14 for more information on this service.

See servicediscovery package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/servicediscovery/

Using the Client

To contact AWS Cloud Map with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Cloud Map client ServiceDiscovery for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/servicediscovery/#New

Index

Examples

Constants

View Source 
const (
	// CustomHealthStatusHealthy is a CustomHealthStatus enum value
	CustomHealthStatusHealthy = "HEALTHY"

	// CustomHealthStatusUnhealthy is a CustomHealthStatus enum value
	CustomHealthStatusUnhealthy = "UNHEALTHY"
)
View Source 
const (
	// FilterConditionEq is a FilterCondition enum value
	FilterConditionEq = "EQ"

	// FilterConditionIn is a FilterCondition enum value
	FilterConditionIn = "IN"

	// FilterConditionBetween is a FilterCondition enum value
	FilterConditionBetween = "BETWEEN"
)
View Source 
const (
	// HealthCheckTypeHttp is a HealthCheckType enum value
	HealthCheckTypeHttp = "HTTP"

	// HealthCheckTypeHttps is a HealthCheckType enum value
	HealthCheckTypeHttps = "HTTPS"

	// HealthCheckTypeTcp is a HealthCheckType enum value
	HealthCheckTypeTcp = "TCP"
)
View Source 
const (
	// HealthStatusHealthy is a HealthStatus enum value
	HealthStatusHealthy = "HEALTHY"

	// HealthStatusUnhealthy is a HealthStatus enum value
	HealthStatusUnhealthy = "UNHEALTHY"

	// HealthStatusUnknown is a HealthStatus enum value
	HealthStatusUnknown = "UNKNOWN"
)
View Source 
const (
	// HealthStatusFilterHealthy is a HealthStatusFilter enum value
	HealthStatusFilterHealthy = "HEALTHY"

	// HealthStatusFilterUnhealthy is a HealthStatusFilter enum value
	HealthStatusFilterUnhealthy = "UNHEALTHY"

	// HealthStatusFilterAll is a HealthStatusFilter enum value
	HealthStatusFilterAll = "ALL"
)
View Source 
const (
	// NamespaceTypeDnsPublic is a NamespaceType enum value
	NamespaceTypeDnsPublic = "DNS_PUBLIC"

	// NamespaceTypeDnsPrivate is a NamespaceType enum value
	NamespaceTypeDnsPrivate = "DNS_PRIVATE"

	// NamespaceTypeHttp is a NamespaceType enum value
	NamespaceTypeHttp = "HTTP"
)
View Source 
const (
	// OperationFilterNameNamespaceId is a OperationFilterName enum value
	OperationFilterNameNamespaceId = "NAMESPACE_ID"

	// OperationFilterNameServiceId is a OperationFilterName enum value
	OperationFilterNameServiceId = "SERVICE_ID"

	// OperationFilterNameStatus is a OperationFilterName enum value
	OperationFilterNameStatus = "STATUS"

	// OperationFilterNameType is a OperationFilterName enum value
	OperationFilterNameType = "TYPE"

	// OperationFilterNameUpdateDate is a OperationFilterName enum value
	OperationFilterNameUpdateDate = "UPDATE_DATE"
)
View Source 
const (
	// OperationStatusSubmitted is a OperationStatus enum value
	OperationStatusSubmitted = "SUBMITTED"

	// OperationStatusPending is a OperationStatus enum value
	OperationStatusPending = "PENDING"

	// OperationStatusSuccess is a OperationStatus enum value
	OperationStatusSuccess = "SUCCESS"

	// OperationStatusFail is a OperationStatus enum value
	OperationStatusFail = "FAIL"
)
View Source 
const (
	// OperationTargetTypeNamespace is a OperationTargetType enum value
	OperationTargetTypeNamespace = "NAMESPACE"

	// OperationTargetTypeService is a OperationTargetType enum value
	OperationTargetTypeService = "SERVICE"

	// OperationTargetTypeInstance is a OperationTargetType enum value
	OperationTargetTypeInstance = "INSTANCE"
)
View Source 
const (
	// OperationTypeCreateNamespace is a OperationType enum value
	OperationTypeCreateNamespace = "CREATE_NAMESPACE"

	// OperationTypeDeleteNamespace is a OperationType enum value
	OperationTypeDeleteNamespace = "DELETE_NAMESPACE"

	// OperationTypeUpdateService is a OperationType enum value
	OperationTypeUpdateService = "UPDATE_SERVICE"

	// OperationTypeRegisterInstance is a OperationType enum value
	OperationTypeRegisterInstance = "REGISTER_INSTANCE"

	// OperationTypeDeregisterInstance is a OperationType enum value
	OperationTypeDeregisterInstance = "DEREGISTER_INSTANCE"
)
View Source 
const (
	// RecordTypeSrv is a RecordType enum value
	RecordTypeSrv = "SRV"

	// RecordTypeA is a RecordType enum value
	RecordTypeA = "A"

	// RecordTypeAaaa is a RecordType enum value
	RecordTypeAaaa = "AAAA"

	// RecordTypeCname is a RecordType enum value
	RecordTypeCname = "CNAME"
)
View Source 
const (
	// RoutingPolicyMultivalue is a RoutingPolicy enum value
	RoutingPolicyMultivalue = "MULTIVALUE"

	// RoutingPolicyWeighted is a RoutingPolicy enum value
	RoutingPolicyWeighted = "WEIGHTED"
)
View Source 
const (
	// ServiceTypeHttp is a ServiceType enum value
	ServiceTypeHttp = "HTTP"

	// ServiceTypeDnsHttp is a ServiceType enum value
	ServiceTypeDnsHttp = "DNS_HTTP"

	// ServiceTypeDns is a ServiceType enum value
	ServiceTypeDns = "DNS"
)
View Source 
const (

	// ErrCodeCustomHealthNotFound for service response error code
	// "CustomHealthNotFound".
	//
	// The health check for the instance that is specified by ServiceId and InstanceId
	// is not a custom health check.
	ErrCodeCustomHealthNotFound = "CustomHealthNotFound"

	// ErrCodeDuplicateRequest for service response error code
	// "DuplicateRequest".
	//
	// The operation is already in progress.
	ErrCodeDuplicateRequest = "DuplicateRequest"

	// ErrCodeInstanceNotFound for service response error code
	// "InstanceNotFound".
	//
	// No instance exists with the specified ID, or the instance was recently registered,
	// and information about the instance hasn't propagated yet.
	ErrCodeInstanceNotFound = "InstanceNotFound"

	// ErrCodeInvalidInput for service response error code
	// "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.
	ErrCodeInvalidInput = "InvalidInput"

	// ErrCodeNamespaceAlreadyExists for service response error code
	// "NamespaceAlreadyExists".
	//
	// The namespace that you're trying to create already exists.
	ErrCodeNamespaceAlreadyExists = "NamespaceAlreadyExists"

	// ErrCodeNamespaceNotFound for service response error code
	// "NamespaceNotFound".
	//
	// No namespace exists with the specified ID.
	ErrCodeNamespaceNotFound = "NamespaceNotFound"

	// ErrCodeOperationNotFound for service response error code
	// "OperationNotFound".
	//
	// No operation exists with the specified ID.
	ErrCodeOperationNotFound = "OperationNotFound"

	// ErrCodeRequestLimitExceeded for service response error code
	// "RequestLimitExceeded".
	//
	// The operation can't be completed because you've reached the quota for the
	// number of requests. For more information, see AWS Cloud Map API request throttling
	// quota (https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html) in
	// the AWS Cloud Map Developer Guide.
	ErrCodeRequestLimitExceeded = "RequestLimitExceeded"

	// ErrCodeResourceInUse for service response error code
	// "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.
	ErrCodeResourceInUse = "ResourceInUse"

	// ErrCodeResourceLimitExceeded for service response error code
	// "ResourceLimitExceeded".
	//
	// The resource can't be created because you've reached the quota on the number
	// of resources.
	ErrCodeResourceLimitExceeded = "ResourceLimitExceeded"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The operation can't be completed because the resource was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceAlreadyExists for service response error code
	// "ServiceAlreadyExists".
	//
	// The service can't be created because a service with the same name already
	// exists.
	ErrCodeServiceAlreadyExists = "ServiceAlreadyExists"

	// ErrCodeServiceNotFound for service response error code
	// "ServiceNotFound".
	//
	// No service exists with the specified ID.
	ErrCodeServiceNotFound = "ServiceNotFound"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// The list of tags on the resource is over the quota. The maximum number of
	// tags that can be applied to a resource is 50.
	ErrCodeTooManyTagsException = "TooManyTagsException"
)
View Source 
const (
	ServiceName = "servicediscovery" // Name of service.
	EndpointsID = ServiceName        // ID to lookup a service endpoint with.
	ServiceID   = "ServiceDiscovery" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// NamespaceFilterNameType is a NamespaceFilterName enum value
	NamespaceFilterNameType = "TYPE"
)
View Source 
const (
	// ServiceFilterNameNamespaceId is a ServiceFilterName enum value
	ServiceFilterNameNamespaceId = "NAMESPACE_ID"
)
View Source 
const (
	// ServiceTypeOptionHttp is a ServiceTypeOption enum value
	ServiceTypeOptionHttp = "HTTP"
)

Variables

This section is empty.

Functions

func CustomHealthStatus_Values added in v1.34.3 

func CustomHealthStatus_Values() []string

CustomHealthStatus_Values returns all elements of the CustomHealthStatus enum

func FilterCondition_Values added in v1.34.3 

func FilterCondition_Values() []string

FilterCondition_Values returns all elements of the FilterCondition enum

func HealthCheckType_Values added in v1.34.3 

func HealthCheckType_Values() []string

HealthCheckType_Values returns all elements of the HealthCheckType enum

func HealthStatusFilter_Values added in v1.34.3 

func HealthStatusFilter_Values() []string

HealthStatusFilter_Values returns all elements of the HealthStatusFilter enum

func HealthStatus_Values added in v1.34.3 

func HealthStatus_Values() []string

HealthStatus_Values returns all elements of the HealthStatus enum

func NamespaceFilterName_Values added in v1.34.3 

func NamespaceFilterName_Values() []string

NamespaceFilterName_Values returns all elements of the NamespaceFilterName enum

func NamespaceType_Values added in v1.34.3 

func NamespaceType_Values() []string

NamespaceType_Values returns all elements of the NamespaceType enum

func OperationFilterName_Values added in v1.34.3 

func OperationFilterName_Values() []string

OperationFilterName_Values returns all elements of the OperationFilterName enum

func OperationStatus_Values added in v1.34.3 

func OperationStatus_Values() []string

OperationStatus_Values returns all elements of the OperationStatus enum

func OperationTargetType_Values added in v1.34.3 

func OperationTargetType_Values() []string

OperationTargetType_Values returns all elements of the OperationTargetType enum

func OperationType_Values added in v1.34.3 

func OperationType_Values() []string

OperationType_Values returns all elements of the OperationType enum

func RecordType_Values added in v1.34.3 

func RecordType_Values() []string

RecordType_Values returns all elements of the RecordType enum

func RoutingPolicy_Values added in v1.34.3 

func RoutingPolicy_Values() []string

RoutingPolicy_Values returns all elements of the RoutingPolicy enum

func ServiceFilterName_Values added in v1.34.3 

func ServiceFilterName_Values() []string

ServiceFilterName_Values returns all elements of the ServiceFilterName enum

func ServiceTypeOption_Values added in v1.37.24 

func ServiceTypeOption_Values() []string

ServiceTypeOption_Values returns all elements of the ServiceTypeOption enum

func ServiceType_Values added in v1.37.24 

func ServiceType_Values() []string

ServiceType_Values returns all elements of the ServiceType enum

Types

type CreateHttpNamespaceInput added in v1.15.86 

type CreateHttpNamespaceInput struct {

	// A unique string that identifies the request and that allows failed CreateHttpNamespace
	// requests to be retried without the risk of executing the operation twice.
	// CreatorRequestId can be any unique string, for example, a date/time stamp.
	CreatorRequestId *string `type:"string" idempotencyToken:"true"`

	// A description for the namespace.
	Description *string `type:"string"`

	// The name that you want to assign to this namespace.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The tags to add to the namespace. Each tag consists of a key and an optional
	// value, both of which you define. Tag keys can have a maximum character length
	// of 128 characters, and tag values can have a maximum length of 256 characters.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreateHttpNamespaceInput) GoString added in v1.15.86 

func (s CreateHttpNamespaceInput) GoString() string

GoString returns the string representation

func (*CreateHttpNamespaceInput) SetCreatorRequestId added in v1.15.86 

func (s *CreateHttpNamespaceInput) SetCreatorRequestId(v string) *CreateHttpNamespaceInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*CreateHttpNamespaceInput) SetDescription added in v1.15.86 

func (s *CreateHttpNamespaceInput) SetDescription(v string) *CreateHttpNamespaceInput

SetDescription sets the Description field's value.

func (*CreateHttpNamespaceInput) SetName added in v1.15.86 

func (s *CreateHttpNamespaceInput) SetName(v string) *CreateHttpNamespaceInput

SetName sets the Name field's value.

func (*CreateHttpNamespaceInput) SetTags added in v1.31.13 

func (s *CreateHttpNamespaceInput) SetTags(v []*Tag) *CreateHttpNamespaceInput

SetTags sets the Tags field's value.

func (CreateHttpNamespaceInput) String added in v1.15.86 

func (s CreateHttpNamespaceInput) String() string

String returns the string representation

func (*CreateHttpNamespaceInput) Validate added in v1.15.86 

func (s *CreateHttpNamespaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateHttpNamespaceOutput added in v1.15.86 

type CreateHttpNamespaceOutput struct {

	// A value that you can use to determine whether the request completed successfully.
	// To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html).
	OperationId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateHttpNamespaceOutput) GoString added in v1.15.86 

func (s CreateHttpNamespaceOutput) GoString() string

GoString returns the string representation

func (*CreateHttpNamespaceOutput) SetOperationId added in v1.15.86 

func (s *CreateHttpNamespaceOutput) SetOperationId(v string) *CreateHttpNamespaceOutput

SetOperationId sets the OperationId field's value.

func (CreateHttpNamespaceOutput) String added in v1.15.86 

func (s CreateHttpNamespaceOutput) String() string

String returns the string representation

type CreatePrivateDnsNamespaceInput 

type CreatePrivateDnsNamespaceInput struct {

	// A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace
	// requests to be retried without the risk of executing the operation twice.
	// CreatorRequestId can be any unique string, for example, a date/time stamp.
	CreatorRequestId *string `type:"string" idempotencyToken:"true"`

	// A description for the namespace.
	Description *string `type:"string"`

	// The name that you want to assign to this namespace. When you create a private
	// DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private
	// hosted zone that has the same name as the namespace.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The tags to add to the namespace. Each tag consists of a key and an optional
	// value, both of which you define. Tag keys can have a maximum character length
	// of 128 characters, and tag values can have a maximum length of 256 characters.
	Tags []*Tag `type:"list"`

	// The ID of the Amazon VPC that you want to associate the namespace with.
	//
	// Vpc is a required field
	Vpc *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePrivateDnsNamespaceInput) GoString 

func (s CreatePrivateDnsNamespaceInput) GoString() string

GoString returns the string representation

func (*CreatePrivateDnsNamespaceInput) SetCreatorRequestId 

func (s *CreatePrivateDnsNamespaceInput) SetCreatorRequestId(v string) *CreatePrivateDnsNamespaceInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*CreatePrivateDnsNamespaceInput) SetDescription 

func (s *CreatePrivateDnsNamespaceInput) SetDescription(v string) *CreatePrivateDnsNamespaceInput

SetDescription sets the Description field's value.

func (*CreatePrivateDnsNamespaceInput) SetName 

func (s *CreatePrivateDnsNamespaceInput) SetName(v string) *CreatePrivateDnsNamespaceInput

SetName sets the Name field's value.

func (*CreatePrivateDnsNamespaceInput) SetTags added in v1.31.13 

func (s *CreatePrivateDnsNamespaceInput) SetTags(v []*Tag) *CreatePrivateDnsNamespaceInput

SetTags sets the Tags field's value.

func (*CreatePrivateDnsNamespaceInput) SetVpc 

func (s *CreatePrivateDnsNamespaceInput) SetVpc(v string) *CreatePrivateDnsNamespaceInput

SetVpc sets the Vpc field's value.

func (CreatePrivateDnsNamespaceInput) String 

func (s CreatePrivateDnsNamespaceInput) String() string

String returns the string representation

func (*CreatePrivateDnsNamespaceInput) Validate 

func (s *CreatePrivateDnsNamespaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePrivateDnsNamespaceOutput 

type CreatePrivateDnsNamespaceOutput struct {

	// A value that you can use to determine whether the request completed successfully.
	// To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html).
	OperationId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreatePrivateDnsNamespaceOutput) GoString 

func (s CreatePrivateDnsNamespaceOutput) GoString() string

GoString returns the string representation

func (*CreatePrivateDnsNamespaceOutput) SetOperationId 

func (s *CreatePrivateDnsNamespaceOutput) SetOperationId(v string) *CreatePrivateDnsNamespaceOutput

SetOperationId sets the OperationId field's value.

func (CreatePrivateDnsNamespaceOutput) String 

func (s CreatePrivateDnsNamespaceOutput) String() string

String returns the string representation

type CreatePublicDnsNamespaceInput 

type CreatePublicDnsNamespaceInput struct {

	// A unique string that identifies the request and that allows failed CreatePublicDnsNamespace
	// requests to be retried without the risk of executing the operation twice.
	// CreatorRequestId can be any unique string, for example, a date/time stamp.
	CreatorRequestId *string `type:"string" idempotencyToken:"true"`

	// A description for the namespace.
	Description *string `type:"string"`

	// The name that you want to assign to this namespace.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The tags to add to the namespace. Each tag consists of a key and an optional
	// value, both of which you define. Tag keys can have a maximum character length
	// of 128 characters, and tag values can have a maximum length of 256 characters.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (CreatePublicDnsNamespaceInput) GoString 

func (s CreatePublicDnsNamespaceInput) GoString() string

GoString returns the string representation

func (*CreatePublicDnsNamespaceInput) SetCreatorRequestId 

func (s *CreatePublicDnsNamespaceInput) SetCreatorRequestId(v string) *CreatePublicDnsNamespaceInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*CreatePublicDnsNamespaceInput) SetDescription 

func (s *CreatePublicDnsNamespaceInput) SetDescription(v string) *CreatePublicDnsNamespaceInput

SetDescription sets the Description field's value.

func (*CreatePublicDnsNamespaceInput) SetName 

func (s *CreatePublicDnsNamespaceInput) SetName(v string) *CreatePublicDnsNamespaceInput

SetName sets the Name field's value.

func (*CreatePublicDnsNamespaceInput) SetTags added in v1.31.13 

func (s *CreatePublicDnsNamespaceInput) SetTags(v []*Tag) *CreatePublicDnsNamespaceInput

SetTags sets the Tags field's value.

func (CreatePublicDnsNamespaceInput) String 

func (s CreatePublicDnsNamespaceInput) String() string

String returns the string representation

func (*CreatePublicDnsNamespaceInput) Validate 

func (s *CreatePublicDnsNamespaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreatePublicDnsNamespaceOutput 

type CreatePublicDnsNamespaceOutput struct {

	// A value that you can use to determine whether the request completed successfully.
	// To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html).
	OperationId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreatePublicDnsNamespaceOutput) GoString 

func (s CreatePublicDnsNamespaceOutput) GoString() string

GoString returns the string representation

func (*CreatePublicDnsNamespaceOutput) SetOperationId 

func (s *CreatePublicDnsNamespaceOutput) SetOperationId(v string) *CreatePublicDnsNamespaceOutput

SetOperationId sets the OperationId field's value.

func (CreatePublicDnsNamespaceOutput) String 

func (s CreatePublicDnsNamespaceOutput) String() string

String returns the string representation

type CreateServiceInput 

type CreateServiceInput struct {

	// A unique string that identifies the request and that allows failed CreateService
	// requests to be retried without the risk of executing the operation twice.
	// CreatorRequestId can be any unique string, for example, a date/time stamp.
	CreatorRequestId *string `type:"string" idempotencyToken:"true"`

	// A description for the service.
	Description *string `type:"string"`

	// A complex type that contains information about the Amazon Route 53 records
	// that you want AWS Cloud Map to create when you register an instance.
	DnsConfig *DnsConfig `type:"structure"`

	// Public DNS and HTTP namespaces only. A complex type that contains settings
	// for an optional Route 53 health check. If you specify settings for a health
	// check, AWS Cloud Map associates the health check with all the Route 53 DNS
	// records that you specify in DnsConfig.
	//
	// If you specify a health check configuration, you can specify either HealthCheckCustomConfig
	// or HealthCheckConfig but not both.
	//
	// For information about the charges for health checks, see AWS Cloud Map Pricing
	// (http://aws.amazon.com/cloud-map/pricing/).
	HealthCheckConfig *HealthCheckConfig `type:"structure"`

	// A complex type that contains information about an optional custom health
	// check.
	//
	// If you specify a health check configuration, you can specify either HealthCheckCustomConfig
	// or HealthCheckConfig but not both.
	//
	// You can't add, update, or delete a HealthCheckCustomConfig configuration
	// from an existing service.
	HealthCheckCustomConfig *HealthCheckCustomConfig `type:"structure"`

	// The name that you want to assign to the service.
	//
	// If you want AWS Cloud Map to create an SRV record when you register an instance,
	// and if you're using a system that requires a specific SRV format, such as
	// HAProxy (http://www.haproxy.org/), specify the following for Name:
	//
	//    * Start the name with an underscore (_), such as _exampleservice
	//
	//    * End the name with ._protocol, such as ._tcp
	//
	// When you register an instance, AWS Cloud Map creates an SRV record and assigns
	// a name to the record by concatenating the service name and the namespace
	// name, for example:
	//
	// _exampleservice._tcp.example.com
	//
	// For a single DNS namespace, you cannot create two services with names that
	// differ only by case (such as EXAMPLE and example). Otherwise, these services
	// will have the same DNS name. However, you can create multiple HTTP services
	// with names that differ only by case because HTTP services are case sensitive.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The ID of the namespace that you want to use to create the service.
	NamespaceId *string `type:"string"`

	// The tags to add to the service. Each tag consists of a key and an optional
	// value, both of which you define. Tag keys can have a maximum character length
	// of 128 characters, and tag values can have a maximum length of 256 characters.
	Tags []*Tag `type:"list"`

	// If present, specifies that the service instances are only discoverable using
	// the DiscoverInstances API operation. No DNS records will be registered for
	// the service instances. The only valid value is HTTP.
	Type *string `type:"string" enum:"ServiceTypeOption"`
	// contains filtered or unexported fields
}

func (CreateServiceInput) GoString 

func (s CreateServiceInput) GoString() string

GoString returns the string representation

func (*CreateServiceInput) SetCreatorRequestId 

func (s *CreateServiceInput) SetCreatorRequestId(v string) *CreateServiceInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*CreateServiceInput) SetDescription 

func (s *CreateServiceInput) SetDescription(v string) *CreateServiceInput

SetDescription sets the Description field's value.

func (*CreateServiceInput) SetDnsConfig 

func (s *CreateServiceInput) SetDnsConfig(v *DnsConfig) *CreateServiceInput

SetDnsConfig sets the DnsConfig field's value.

func (*CreateServiceInput) SetHealthCheckConfig 

func (s *CreateServiceInput) SetHealthCheckConfig(v *HealthCheckConfig) *CreateServiceInput

SetHealthCheckConfig sets the HealthCheckConfig field's value.

func (*CreateServiceInput) SetHealthCheckCustomConfig added in v1.13.13 

func (s *CreateServiceInput) SetHealthCheckCustomConfig(v *HealthCheckCustomConfig) *CreateServiceInput

SetHealthCheckCustomConfig sets the HealthCheckCustomConfig field's value.

func (*CreateServiceInput) SetName 

func (s *CreateServiceInput) SetName(v string) *CreateServiceInput

SetName sets the Name field's value.

func (*CreateServiceInput) SetNamespaceId added in v1.15.86 

func (s *CreateServiceInput) SetNamespaceId(v string) *CreateServiceInput

SetNamespaceId sets the NamespaceId field's value.

func (*CreateServiceInput) SetTags added in v1.31.13 

func (s *CreateServiceInput) SetTags(v []*Tag) *CreateServiceInput

SetTags sets the Tags field's value.

func (*CreateServiceInput) SetType added in v1.37.24 

func (s *CreateServiceInput) SetType(v string) *CreateServiceInput

SetType sets the Type field's value.

func (CreateServiceInput) String 

func (s CreateServiceInput) String() string

String returns the string representation

func (*CreateServiceInput) Validate 

func (s *CreateServiceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateServiceOutput 

type CreateServiceOutput struct {

	// A complex type that contains information about the new service.
	Service *Service `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateServiceOutput) GoString 

func (s CreateServiceOutput) GoString() string

GoString returns the string representation

func (*CreateServiceOutput) SetService 

func (s *CreateServiceOutput) SetService(v *Service) *CreateServiceOutput

SetService sets the Service field's value.

func (CreateServiceOutput) String 

func (s CreateServiceOutput) String() string

String returns the string representation

type CustomHealthNotFound added in v1.28.0 

type CustomHealthNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*CustomHealthNotFound) Code added in v1.28.0 

func (s *CustomHealthNotFound) Code() string

Code returns the exception type name.

func (*CustomHealthNotFound) Error added in v1.28.0 

func (s *CustomHealthNotFound) Error() string

func (CustomHealthNotFound) GoString added in v1.28.0 

func (s CustomHealthNotFound) GoString() string

GoString returns the string representation

func (*CustomHealthNotFound) Message added in v1.28.0 

func (s *CustomHealthNotFound) Message() string

Message returns the exception's message.

func (*CustomHealthNotFound) OrigErr added in v1.28.0 

func (s *CustomHealthNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CustomHealthNotFound) RequestID added in v1.28.0 

func (s *CustomHealthNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CustomHealthNotFound) StatusCode added in v1.28.0 

func (s *CustomHealthNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CustomHealthNotFound) String added in v1.28.0 

func (s CustomHealthNotFound) String() string

String returns the string representation

type DeleteNamespaceInput 

type DeleteNamespaceInput struct {

	// The ID of the namespace that you want to delete.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteNamespaceInput) GoString 

func (s DeleteNamespaceInput) GoString() string

GoString returns the string representation

func (*DeleteNamespaceInput) SetId 

func (s *DeleteNamespaceInput) SetId(v string) *DeleteNamespaceInput

SetId sets the Id field's value.

func (DeleteNamespaceInput) String 

func (s DeleteNamespaceInput) String() string

String returns the string representation

func (*DeleteNamespaceInput) Validate 

func (s *DeleteNamespaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteNamespaceOutput 

type DeleteNamespaceOutput struct {

	// A value that you can use to determine whether the request completed successfully.
	// To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html).
	OperationId *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteNamespaceOutput) GoString 

func (s DeleteNamespaceOutput) GoString() string

GoString returns the string representation

func (*DeleteNamespaceOutput) SetOperationId 

func (s *DeleteNamespaceOutput) SetOperationId(v string) *DeleteNamespaceOutput

SetOperationId sets the OperationId field's value.

func (DeleteNamespaceOutput) String 

func (s DeleteNamespaceOutput) String() string

String returns the string representation

type DeleteServiceInput 

type DeleteServiceInput struct {

	// The ID of the service that you want to delete.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteServiceInput) GoString 

func (s DeleteServiceInput) GoString() string

GoString returns the string representation

func (*DeleteServiceInput) SetId 

func (s *DeleteServiceInput) SetId(v string) *DeleteServiceInput

SetId sets the Id field's value.

func (DeleteServiceInput) String 

func (s DeleteServiceInput) String() string

String returns the string representation

func (*DeleteServiceInput) Validate 

func (s *DeleteServiceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteServiceOutput 

type DeleteServiceOutput struct {
	// contains filtered or unexported fields
}

func (DeleteServiceOutput) GoString 

func (s DeleteServiceOutput) GoString() string

GoString returns the string representation

func (DeleteServiceOutput) String 

func (s DeleteServiceOutput) String() string

String returns the string representation

type DeregisterInstanceInput 

type DeregisterInstanceInput struct {

	// The value that you specified for Id in the RegisterInstance (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html)
	// request.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The ID of the service that the instance is associated with.
	//
	// ServiceId is a required field
	ServiceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeregisterInstanceInput) GoString 

func (s DeregisterInstanceInput) GoString() string

GoString returns the string representation

func (*DeregisterInstanceInput) SetInstanceId 

func (s *DeregisterInstanceInput) SetInstanceId(v string) *DeregisterInstanceInput

SetInstanceId sets the InstanceId field's value.

func (*DeregisterInstanceInput) SetServiceId 

func (s *DeregisterInstanceInput) SetServiceId(v string) *DeregisterInstanceInput

SetServiceId sets the ServiceId field's value.

func (DeregisterInstanceInput) String 

func (s DeregisterInstanceInput) String() string

String returns the string representation

func (*DeregisterInstanceInput) Validate 

func (s *DeregisterInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeregisterInstanceOutput 

type DeregisterInstanceOutput struct {

	// A value that you can use to determine whether the request completed successfully.
	// For more information, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html).
	OperationId *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeregisterInstanceOutput) GoString 

func (s DeregisterInstanceOutput) GoString() string

GoString returns the string representation

func (*DeregisterInstanceOutput) SetOperationId 

func (s *DeregisterInstanceOutput) SetOperationId(v string) *DeregisterInstanceOutput

SetOperationId sets the OperationId field's value.

func (DeregisterInstanceOutput) String 

func (s DeregisterInstanceOutput) String() string

String returns the string representation

type DiscoverInstancesInput added in v1.15.86 

type DiscoverInstancesInput struct {

	// The health status of the instances that you want to discover.
	HealthStatus *string `type:"string" enum:"HealthStatusFilter"`

	// The maximum number of instances that you want AWS Cloud Map to return in
	// the response to a DiscoverInstances request. If you don't specify a value
	// for MaxResults, AWS Cloud Map returns up to 100 instances.
	MaxResults *int64 `min:"1" type:"integer"`

	// The name of the namespace that you specified when you registered the instance.
	//
	// NamespaceName is a required field
	NamespaceName *string `type:"string" required:"true"`

	// Opportunistic filters to scope the results based on custom attributes. If
	// there are instances that match both the filters specified in both the QueryParameters
	// parameter and this parameter, they are returned. Otherwise, these filters
	// are ignored and only instances that match the filters specified in the QueryParameters
	// parameter are returned.
	OptionalParameters map[string]*string `type:"map"`

	// Filters to scope the results based on custom attributes for the instance.
	// For example, {version=v1, az=1a}. Only instances that match all the specified
	// key-value pairs will be returned.
	QueryParameters map[string]*string `type:"map"`

	// The name of the service that you specified when you registered the instance.
	//
	// ServiceName is a required field
	ServiceName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DiscoverInstancesInput) GoString added in v1.15.86 

func (s DiscoverInstancesInput) GoString() string

GoString returns the string representation

func (*DiscoverInstancesInput) SetHealthStatus added in v1.15.86 

func (s *DiscoverInstancesInput) SetHealthStatus(v string) *DiscoverInstancesInput

SetHealthStatus sets the HealthStatus field's value.

func (*DiscoverInstancesInput) SetMaxResults added in v1.15.86 

func (s *DiscoverInstancesInput) SetMaxResults(v int64) *DiscoverInstancesInput

SetMaxResults sets the MaxResults field's value.

func (*DiscoverInstancesInput) SetNamespaceName added in v1.15.86 

func (s *DiscoverInstancesInput) SetNamespaceName(v string) *DiscoverInstancesInput

SetNamespaceName sets the NamespaceName field's value.

func (*DiscoverInstancesInput) SetOptionalParameters added in v1.35.2 

func (s *DiscoverInstancesInput) SetOptionalParameters(v map[string]*string) *DiscoverInstancesInput

SetOptionalParameters sets the OptionalParameters field's value.

func (*DiscoverInstancesInput) SetQueryParameters added in v1.15.86 

func (s *DiscoverInstancesInput) SetQueryParameters(v map[string]*string) *DiscoverInstancesInput

SetQueryParameters sets the QueryParameters field's value.

func (*DiscoverInstancesInput) SetServiceName added in v1.15.86 

func (s *DiscoverInstancesInput) SetServiceName(v string) *DiscoverInstancesInput

SetServiceName sets the ServiceName field's value.

func (DiscoverInstancesInput) String added in v1.15.86 

func (s DiscoverInstancesInput) String() string

String returns the string representation

func (*DiscoverInstancesInput) Validate added in v1.15.86 

func (s *DiscoverInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DiscoverInstancesOutput added in v1.15.86 

type DiscoverInstancesOutput struct {

	// A complex type that contains one HttpInstanceSummary for each registered
	// instance.
	Instances []*HttpInstanceSummary `type:"list"`
	// contains filtered or unexported fields
}

func (DiscoverInstancesOutput) GoString added in v1.15.86 

func (s DiscoverInstancesOutput) GoString() string

GoString returns the string representation

func (*DiscoverInstancesOutput) SetInstances added in v1.15.86 

func (s *DiscoverInstancesOutput) SetInstances(v []*HttpInstanceSummary) *DiscoverInstancesOutput

SetInstances sets the Instances field's value.

func (DiscoverInstancesOutput) String added in v1.15.86 

func (s DiscoverInstancesOutput) String() string

String returns the string representation

type DnsConfig 

type DnsConfig struct {

	// An array that contains one DnsRecord object for each Route 53 DNS record
	// that you want AWS Cloud Map to create when you register an instance.
	//
	// DnsRecords is a required field
	DnsRecords []*DnsRecord `type:"list" required:"true"`

	// The ID of the namespace to use for DNS configuration.
	//
	// Deprecated: Top level attribute in request should be used to reference namespace-id
	NamespaceId *string `deprecated:"true" type:"string"`

	// The routing policy that you want to apply to all Route 53 DNS records that
	// AWS Cloud Map creates when you register an instance and specify this service.
	//
	// If you want to use this service to register instances that create alias records,
	// specify WEIGHTED for the routing policy.
	//
	// You can specify the following values:
	//
	// MULTIVALUE
	//
	// If you define a health check for the service and the health check is healthy,
	// Route 53 returns the applicable value for up to eight instances.
	//
	// For example, suppose the service includes configurations for one A record
	// and a health check, and you use the service to register 10 instances. Route
	// 53 responds to DNS queries with IP addresses for up to eight healthy instances.
	// If fewer than eight instances are healthy, Route 53 responds to every DNS
	// query with the IP addresses for all of the healthy instances.
	//
	// If you don't define a health check for the service, Route 53 assumes that
	// all instances are healthy and returns the values for up to eight instances.
	//
	// For more information about the multivalue routing policy, see Multivalue
	// Answer Routing (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue)
	// in the Route 53 Developer Guide.
	//
	// WEIGHTED
	//
	// Route 53 returns the applicable value from one randomly selected instance
	// from among the instances that you registered using the same service. Currently,
	// all records have the same weight, so you can't route more or less traffic
	// to any instances.
	//
	// For example, suppose the service includes configurations for one A record
	// and a health check, and you use the service to register 10 instances. Route
	// 53 responds to DNS queries with the IP address for one randomly selected
	// instance from among the healthy instances. If no instances are healthy, Route
	// 53 responds to DNS queries as if all of the instances were healthy.
	//
	// If you don't define a health check for the service, Route 53 assumes that
	// all instances are healthy and returns the applicable value for one randomly
	// selected instance.
	//
	// For more information about the weighted routing policy, see Weighted Routing
	// (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted)
	// in the Route 53 Developer Guide.
	RoutingPolicy *string `type:"string" enum:"RoutingPolicy"`
	// contains filtered or unexported fields
}

A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

func (DnsConfig) GoString 

func (s DnsConfig) GoString() string

GoString returns the string representation

func (*DnsConfig) SetDnsRecords 

func (s *DnsConfig) SetDnsRecords(v []*DnsRecord) *DnsConfig

SetDnsRecords sets the DnsRecords field's value.

func (*DnsConfig) SetNamespaceId 

func (s *DnsConfig) SetNamespaceId(v string) *DnsConfig

SetNamespaceId sets the NamespaceId field's value.

func (*DnsConfig) SetRoutingPolicy added in v1.12.72 

func (s *DnsConfig) SetRoutingPolicy(v string) *DnsConfig

SetRoutingPolicy sets the RoutingPolicy field's value.

func (DnsConfig) String 

func (s DnsConfig) String() string

String returns the string representation

func (*DnsConfig) Validate 

func (s *DnsConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DnsConfigChange 

type DnsConfigChange struct {

	// An array that contains one DnsRecord object for each Route 53 record that
	// you want AWS Cloud Map to create when you register an instance.
	//
	// DnsRecords is a required field
	DnsRecords []*DnsRecord `type:"list" required:"true"`
	// contains filtered or unexported fields
}

A complex type that contains information about changes to the Route 53 DNS records that AWS Cloud Map creates when you register an instance.

func (DnsConfigChange) GoString 

func (s DnsConfigChange) GoString() string

GoString returns the string representation

func (*DnsConfigChange) SetDnsRecords 

func (s *DnsConfigChange) SetDnsRecords(v []*DnsRecord) *DnsConfigChange

SetDnsRecords sets the DnsRecords field's value.

func (DnsConfigChange) String 

func (s DnsConfigChange) String() string

String returns the string representation

func (*DnsConfigChange) Validate 

func (s *DnsConfigChange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DnsProperties 

type DnsProperties struct {

	// The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create
	// a namespace.
	HostedZoneId *string `type:"string"`
	// contains filtered or unexported fields
}

A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

func (DnsProperties) GoString 

func (s DnsProperties) GoString() string

GoString returns the string representation

func (*DnsProperties) SetHostedZoneId 

func (s *DnsProperties) SetHostedZoneId(v string) *DnsProperties

SetHostedZoneId sets the HostedZoneId field's value.

func (DnsProperties) String 

func (s DnsProperties) String() string

String returns the string representation

type DnsRecord 

type DnsRecord struct {

	// The amount of time, in seconds, that you want DNS resolvers to cache the
	// settings for this record.
	//
	// Alias records don't include a TTL because Route 53 uses the TTL for the AWS
	// resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME
	// attribute when you submit a RegisterInstance (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html)
	// request, the TTL value is ignored. Always specify a TTL for the service;
	// you can use a service to register instances that create either alias or non-alias
	// records.
	//
	// TTL is a required field
	TTL *int64 `type:"long" required:"true"`

	// The type of the resource, which indicates the type of value that Route 53
	// returns in response to DNS queries. You can specify values for Type in the
	// following combinations:
	//
	//    * A
	//
	//    * AAAA
	//
	//    * A and AAAA
	//
	//    * SRV
	//
	//    * CNAME
	//
	// If you want AWS Cloud Map to create a Route 53 alias record when you register
	// an instance, specify A or AAAA for Type.
	//
	// You specify other settings, such as the IP address for A and AAAA records,
	// when you register an instance. For more information, see RegisterInstance
	// (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html).
	//
	// The following values are supported:
	//
	// A
	//
	// Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
	//
	// AAAA
	//
	// Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.
	//
	// CNAME
	//
	// Route 53 returns the domain name of the resource, such as www.example.com.
	// Note the following:
	//
	//    * You specify the domain name that you want to route traffic to when you
	//    register an instance. For more information, see Attributes (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#cloudmap-RegisterInstance-request-Attributes)
	//    in the topic RegisterInstance (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html).
	//
	//    * You must specify WEIGHTED for the value of RoutingPolicy.
	//
	//    * You can't specify both CNAME for Type and settings for HealthCheckConfig.
	//    If you do, the request will fail with an InvalidInput error.
	//
	// SRV
	//
	// Route 53 returns the value for an SRV record. The value for an SRV record
	// uses the following values:
	//
	// priority weight port service-hostname
	//
	// Note the following about the values:
	//
	//    * The values of priority and weight are both set to 1 and can't be changed.
	//
	//    * The value of port comes from the value that you specify for the AWS_INSTANCE_PORT
	//    attribute when you submit a RegisterInstance (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html)
	//    request.
	//
	//    * The value of service-hostname is a concatenation of the following values:
	//    The value that you specify for InstanceId when you register an instance.
	//    The name of the service. The name of the namespace. For example, if the
	//    value of InstanceId is test, the name of the service is backend, and the
	//    name of the namespace is example.com, the value of service-hostname is:
	//    test.backend.example.com
	//
	// If you specify settings for an SRV record, note the following:
	//
	//    * If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both
	//    in the RegisterInstance request, AWS Cloud Map automatically creates A
	//    and/or AAAA records that have the same name as the value of service-hostname
	//    in the SRV record. You can ignore these records.
	//
	//    * If you're using a system that requires a specific SRV format, such as
	//    HAProxy, see the Name (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html#cloudmap-CreateService-request-Name)
	//    element in the documentation about CreateService for information about
	//    how to specify the correct name format.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"RecordType"`
	// contains filtered or unexported fields
}

A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

func (DnsRecord) GoString 

func (s DnsRecord) GoString() string

GoString returns the string representation

func (*DnsRecord) SetTTL 

func (s *DnsRecord) SetTTL(v int64) *DnsRecord

SetTTL sets the TTL field's value.

func (*DnsRecord) SetType 

func (s *DnsRecord) SetType(v string) *DnsRecord

SetType sets the Type field's value.

func (DnsRecord) String 

func (s DnsRecord) String() string

String returns the string representation

func (*DnsRecord) Validate 

func (s *DnsRecord) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DuplicateRequest added in v1.28.0 

type DuplicateRequest struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The ID of the operation that is already in progress.
	DuplicateOperationId *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation is already in progress.

func (*DuplicateRequest) Code added in v1.28.0 

func (s *DuplicateRequest) Code() string

Code returns the exception type name.

func (*DuplicateRequest) Error added in v1.28.0 

func (s *DuplicateRequest) Error() string

func (DuplicateRequest) GoString added in v1.28.0 

func (s DuplicateRequest) GoString() string

GoString returns the string representation

func (*DuplicateRequest) Message added in v1.28.0 

func (s *DuplicateRequest) Message() string

Message returns the exception's message.

func (*DuplicateRequest) OrigErr added in v1.28.0 

func (s *DuplicateRequest) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DuplicateRequest) RequestID added in v1.28.0 

func (s *DuplicateRequest) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DuplicateRequest) StatusCode added in v1.28.0 

func (s *DuplicateRequest) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DuplicateRequest) String added in v1.28.0 

func (s DuplicateRequest) String() string

String returns the string representation

type GetInstanceInput 

type GetInstanceInput struct {

	// The ID of the instance that you want to get information about.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The ID of the service that the instance is associated with.
	//
	// ServiceId is a required field
	ServiceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetInstanceInput) GoString 

func (s GetInstanceInput) GoString() string

GoString returns the string representation

func (*GetInstanceInput) SetInstanceId 

func (s *GetInstanceInput) SetInstanceId(v string) *GetInstanceInput

SetInstanceId sets the InstanceId field's value.

func (*GetInstanceInput) SetServiceId 

func (s *GetInstanceInput) SetServiceId(v string) *GetInstanceInput

SetServiceId sets the ServiceId field's value.

func (GetInstanceInput) String 

func (s GetInstanceInput) String() string

String returns the string representation

func (*GetInstanceInput) Validate 

func (s *GetInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstanceOutput 

type GetInstanceOutput struct {

	// A complex type that contains information about a specified instance.
	Instance *Instance `type:"structure"`
	// contains filtered or unexported fields
}

func (GetInstanceOutput) GoString 

func (s GetInstanceOutput) GoString() string

GoString returns the string representation

func (*GetInstanceOutput) SetInstance 

func (s *GetInstanceOutput) SetInstance(v *Instance) *GetInstanceOutput

SetInstance sets the Instance field's value.

func (GetInstanceOutput) String 

func (s GetInstanceOutput) String() string

String returns the string representation

type GetInstancesHealthStatusInput 

type GetInstancesHealthStatusInput struct {

	// An array that contains the IDs of all the instances that you want to get
	// the health status for.
	//
	// If you omit Instances, AWS Cloud Map returns the health status for all the
	// instances that are associated with the specified service.
	//
	// To get the IDs for the instances that you've registered by using a specified
	// service, submit a ListInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html)
	// request.
	Instances []*string `min:"1" type:"list"`

	// The maximum number of instances that you want AWS Cloud Map to return in
	// the response to a GetInstancesHealthStatus request. If you don't specify
	// a value for MaxResults, AWS Cloud Map returns up to 100 instances.
	MaxResults *int64 `min:"1" type:"integer"`

	// For the first GetInstancesHealthStatus request, omit this value.
	//
	// If more than MaxResults instances match the specified criteria, you can submit
	// another GetInstancesHealthStatus request to get the next group of results.
	// Specify the value of NextToken from the previous response in the next request.
	NextToken *string `type:"string"`

	// The ID of the service that the instance is associated with.
	//
	// ServiceId is a required field
	ServiceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetInstancesHealthStatusInput) GoString 

func (s GetInstancesHealthStatusInput) GoString() string

GoString returns the string representation

func (*GetInstancesHealthStatusInput) SetInstances 

func (s *GetInstancesHealthStatusInput) SetInstances(v []*string) *GetInstancesHealthStatusInput

SetInstances sets the Instances field's value.

func (*GetInstancesHealthStatusInput) SetMaxResults 

func (s *GetInstancesHealthStatusInput) SetMaxResults(v int64) *GetInstancesHealthStatusInput

SetMaxResults sets the MaxResults field's value.

func (*GetInstancesHealthStatusInput) SetNextToken 

func (s *GetInstancesHealthStatusInput) SetNextToken(v string) *GetInstancesHealthStatusInput

SetNextToken sets the NextToken field's value.

func (*GetInstancesHealthStatusInput) SetServiceId 

func (s *GetInstancesHealthStatusInput) SetServiceId(v string) *GetInstancesHealthStatusInput

SetServiceId sets the ServiceId field's value.

func (GetInstancesHealthStatusInput) String 

func (s GetInstancesHealthStatusInput) String() string

String returns the string representation

func (*GetInstancesHealthStatusInput) Validate 

func (s *GetInstancesHealthStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetInstancesHealthStatusOutput 

type GetInstancesHealthStatusOutput struct {

	// If more than MaxResults instances match the specified criteria, you can submit
	// another GetInstancesHealthStatus request to get the next group of results.
	// Specify the value of NextToken from the previous response in the next request.
	NextToken *string `type:"string"`

	// A complex type that contains the IDs and the health status of the instances
	// that you specified in the GetInstancesHealthStatus request.
	Status map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (GetInstancesHealthStatusOutput) GoString 

func (s GetInstancesHealthStatusOutput) GoString() string

GoString returns the string representation

func (*GetInstancesHealthStatusOutput) SetNextToken 

func (s *GetInstancesHealthStatusOutput) SetNextToken(v string) *GetInstancesHealthStatusOutput

SetNextToken sets the NextToken field's value.

func (*GetInstancesHealthStatusOutput) SetStatus 

func (s *GetInstancesHealthStatusOutput) SetStatus(v map[string]*string) *GetInstancesHealthStatusOutput

SetStatus sets the Status field's value.

func (GetInstancesHealthStatusOutput) String 

func (s GetInstancesHealthStatusOutput) String() string

String returns the string representation

type GetNamespaceInput 

type GetNamespaceInput struct {

	// The ID of the namespace that you want to get information about.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetNamespaceInput) GoString 

func (s GetNamespaceInput) GoString() string

GoString returns the string representation

func (*GetNamespaceInput) SetId 

func (s *GetNamespaceInput) SetId(v string) *GetNamespaceInput

SetId sets the Id field's value.

func (GetNamespaceInput) String 

func (s GetNamespaceInput) String() string

String returns the string representation

func (*GetNamespaceInput) Validate 

func (s *GetNamespaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetNamespaceOutput 

type GetNamespaceOutput struct {

	// A complex type that contains information about the specified namespace.
	Namespace *Namespace `type:"structure"`
	// contains filtered or unexported fields
}

func (GetNamespaceOutput) GoString 

func (s GetNamespaceOutput) GoString() string

GoString returns the string representation

func (*GetNamespaceOutput) SetNamespace 

func (s *GetNamespaceOutput) SetNamespace(v *Namespace) *GetNamespaceOutput

SetNamespace sets the Namespace field's value.

func (GetNamespaceOutput) String 

func (s GetNamespaceOutput) String() string

String returns the string representation

type GetOperationInput 

type GetOperationInput struct {

	// The ID of the operation that you want to get more information about.
	//
	// OperationId is a required field
	OperationId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetOperationInput) GoString 

func (s GetOperationInput) GoString() string

GoString returns the string representation

func (*GetOperationInput) SetOperationId 

func (s *GetOperationInput) SetOperationId(v string) *GetOperationInput

SetOperationId sets the OperationId field's value.

func (GetOperationInput) String 

func (s GetOperationInput) String() string

String returns the string representation

func (*GetOperationInput) Validate 

func (s *GetOperationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetOperationOutput 

type GetOperationOutput struct {

	// A complex type that contains information about the operation.
	Operation *Operation `type:"structure"`
	// contains filtered or unexported fields
}

func (GetOperationOutput) GoString 

func (s GetOperationOutput) GoString() string

GoString returns the string representation

func (*GetOperationOutput) SetOperation 

func (s *GetOperationOutput) SetOperation(v *Operation) *GetOperationOutput

SetOperation sets the Operation field's value.

func (GetOperationOutput) String 

func (s GetOperationOutput) String() string

String returns the string representation

type GetServiceInput 

type GetServiceInput struct {

	// The ID of the service that you want to get settings for.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetServiceInput) GoString 

func (s GetServiceInput) GoString() string

GoString returns the string representation

func (*GetServiceInput) SetId 

func (s *GetServiceInput) SetId(v string) *GetServiceInput

SetId sets the Id field's value.

func (GetServiceInput) String 

func (s GetServiceInput) String() string

String returns the string representation

func (*GetServiceInput) Validate 

func (s *GetServiceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetServiceOutput 

type GetServiceOutput struct {

	// A complex type that contains information about the service.
	Service *Service `type:"structure"`
	// contains filtered or unexported fields
}

func (GetServiceOutput) GoString 

func (s GetServiceOutput) GoString() string

GoString returns the string representation

func (*GetServiceOutput) SetService 

func (s *GetServiceOutput) SetService(v *Service) *GetServiceOutput

SetService sets the Service field's value.

func (GetServiceOutput) String 

func (s GetServiceOutput) String() string

String returns the string representation

type HealthCheckConfig 

type HealthCheckConfig struct {

	// The number of consecutive health checks that an endpoint must pass or fail
	// for Route 53 to change the current status of the endpoint from unhealthy
	// to healthy or vice versa. For more information, see How Route 53 Determines
	// Whether an Endpoint Is Healthy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
	// in the Route 53 Developer Guide.
	FailureThreshold *int64 `min:"1" type:"integer"`

	// The path that you want Route 53 to request when performing health checks.
	// The path can be any value for which your endpoint will return an HTTP status
	// code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html.
	// Route 53 automatically adds the DNS name for the service. If you don't specify
	// a value for ResourcePath, the default value is /.
	//
	// If you specify TCP for Type, you must not specify a value for ResourcePath.
	ResourcePath *string `type:"string"`

	// The type of health check that you want to create, which indicates how Route
	// 53 determines whether an endpoint is healthy.
	//
	// You can't change the value of Type after you create a health check.
	//
	// You can create the following types of health checks:
	//
	//    * HTTP: Route 53 tries to establish a TCP connection. If successful, Route
	//    53 submits an HTTP request and waits for an HTTP status code of 200 or
	//    greater and less than 400.
	//
	//    * HTTPS: Route 53 tries to establish a TCP connection. If successful,
	//    Route 53 submits an HTTPS request and waits for an HTTP status code of
	//    200 or greater and less than 400. If you specify HTTPS for the value of
	//    Type, the endpoint must support TLS v1.0 or later.
	//
	//    * TCP: Route 53 tries to establish a TCP connection. If you specify TCP
	//    for Type, don't specify a value for ResourcePath.
	//
	// For more information, see How Route 53 Determines Whether an Endpoint Is
	// Healthy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)
	// in the Route 53 Developer Guide.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"HealthCheckType"`
	// contains filtered or unexported fields
}

Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/).

Note the following about configuring health checks. 

A and AAAA records

If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy. 

CNAME records

You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error.

Request interval

A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.

Health checking regions

Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions).

Alias records

When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. Note the following:

Charges for health checks

Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing (http://aws.amazon.com/route53/pricing/).

func (HealthCheckConfig) GoString 

func (s HealthCheckConfig) GoString() string

GoString returns the string representation

func (*HealthCheckConfig) SetFailureThreshold 

func (s *HealthCheckConfig) SetFailureThreshold(v int64) *HealthCheckConfig

SetFailureThreshold sets the FailureThreshold field's value.

func (*HealthCheckConfig) SetResourcePath 

func (s *HealthCheckConfig) SetResourcePath(v string) *HealthCheckConfig

SetResourcePath sets the ResourcePath field's value.

func (*HealthCheckConfig) SetType 

func (s *HealthCheckConfig) SetType(v string) *HealthCheckConfig

SetType sets the Type field's value.

func (HealthCheckConfig) String 

func (s HealthCheckConfig) String() string

String returns the string representation

func (*HealthCheckConfig) Validate 

func (s *HealthCheckConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type HealthCheckCustomConfig added in v1.13.13 

type HealthCheckCustomConfig struct {

	//
	// This parameter has been deprecated and is always set to 1. AWS Cloud Map
	// waits for approximately 30 seconds after receiving an UpdateInstanceCustomHealthStatus
	// request before changing the status of the service instance.
	//
	// The number of 30-second intervals that you want AWS Cloud Map to wait after
	// receiving an UpdateInstanceCustomHealthStatus request before it changes the
	// health status of a service instance.
	//
	// Sending a second or subsequent UpdateInstanceCustomHealthStatus request with
	// the same value before 30 seconds has passed doesn't accelerate the change.
	// AWS Cloud Map still waits 30 seconds after the first request to make the
	// change.
	//
	// Deprecated: Configurable FailureThreshold of HealthCheckCustomConfig is deprecated.  It will always have value 1.
	FailureThreshold *int64 `min:"1" deprecated:"true" type:"integer"`
	// contains filtered or unexported fields
}

A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

  • You can't use a health check that is defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

  • You want to use a third-party health checker regardless of where your resources are.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. AWS Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus request.

Here's how custom health checks work:

You create a service and specify a value for FailureThreshold.

The failure threshold indicates the number of 30-second intervals you want AWS Cloud Map to wait between the time that your application sends an UpdateInstanceCustomHealthStatus (https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html) request and the time that AWS Cloud Map stops routing internet traffic to the corresponding resource.

You register an instance.

You configure a third-party health checker to monitor the resource that is associated with the new instance.

AWS Cloud Map doesn't check the health of the resource directly.

The third-party health-checker determines that the resource is unhealthy and notifies your application.

Your application submits an UpdateInstanceCustomHealthStatus request.

AWS Cloud Map waits for (FailureThreshold x 30) seconds.

If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the resource.

func (HealthCheckCustomConfig) GoString added in v1.13.13 

func (s HealthCheckCustomConfig) GoString() string

GoString returns the string representation

func (*HealthCheckCustomConfig) SetFailureThreshold added in v1.13.13 

func (s *HealthCheckCustomConfig) SetFailureThreshold(v int64) *HealthCheckCustomConfig

SetFailureThreshold sets the FailureThreshold field's value.

func (HealthCheckCustomConfig) String added in v1.13.13 

func (s HealthCheckCustomConfig) String() string

String returns the string representation

func (*HealthCheckCustomConfig) Validate added in v1.13.13 

func (s *HealthCheckCustomConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type HttpInstanceSummary added in v1.15.86 

type HttpInstanceSummary struct {

	// If you included any attributes when you registered the instance, the values
	// of those attributes.
	Attributes map[string]*string `type:"map"`

	// If you configured health checking in the service, the current health status
	// of the service instance.
	HealthStatus *string `type:"string" enum:"HealthStatus"`

	// The ID of an instance that matches the values that you specified in the request.
	InstanceId *string `type:"string"`

	// The name of the namespace that you specified when you registered the instance.
	NamespaceName *string `type:"string"`

	// The name of the service that you specified when you registered the instance.
	ServiceName *string `type:"string"`
	// contains filtered or unexported fields
}

In a response to a DiscoverInstances (https://docs.aws.amazon.com/cloud-map/latest/api/API_DiscoverInstances.html) request, HttpInstanceSummary contains information about one instance that matches the values that you specified in the request.

func (HttpInstanceSummary) GoString added in v1.15.86 

func (s HttpInstanceSummary) GoString() string

GoString returns the string representation

func (*HttpInstanceSummary) SetAttributes added in v1.15.86 

func (s *HttpInstanceSummary) SetAttributes(v map[string]*string) *HttpInstanceSummary

SetAttributes sets the Attributes field's value.

func (*HttpInstanceSummary) SetHealthStatus added in v1.15.86 

func (s *HttpInstanceSummary) SetHealthStatus(v string) *HttpInstanceSummary

SetHealthStatus sets the HealthStatus field's value.

func (*HttpInstanceSummary) SetInstanceId added in v1.15.86 

func (s *HttpInstanceSummary) SetInstanceId(v string) *HttpInstanceSummary

SetInstanceId sets the InstanceId field's value.

func (*HttpInstanceSummary) SetNamespaceName added in v1.15.86 

func (s *HttpInstanceSummary) SetNamespaceName(v string) *HttpInstanceSummary

SetNamespaceName sets the NamespaceName field's value.

func (*HttpInstanceSummary) SetServiceName added in v1.15.86 

func (s *HttpInstanceSummary) SetServiceName(v string) *HttpInstanceSummary

SetServiceName sets the ServiceName field's value.

func (HttpInstanceSummary) String added in v1.15.86 

func (s HttpInstanceSummary) String() string

String returns the string representation

type HttpProperties added in v1.15.86 

type HttpProperties struct {

	// The name of an HTTP namespace.
	HttpName *string `type:"string"`
	// contains filtered or unexported fields
}

A complex type that contains the name of an HTTP namespace.

func (HttpProperties) GoString added in v1.15.86 

func (s HttpProperties) GoString() string

GoString returns the string representation

func (*HttpProperties) SetHttpName added in v1.15.86 

func (s *HttpProperties) SetHttpName(v string) *HttpProperties

SetHttpName sets the HttpName field's value.

func (HttpProperties) String added in v1.15.86 

func (s HttpProperties) String() string

String returns the string representation

type Instance 

type Instance struct {

	// A string map that contains the following information for the service that
	// you specify in ServiceId:
	//
	//    * The attributes that apply to the records that are defined in the service.
	//
	//    * For each attribute, the applicable value.
	//
	// Supported attribute keys include the following:
	//
	// AWS_ALIAS_DNS_NAME
	//
	// If you want AWS Cloud Map to create a Route 53 alias record that routes traffic
	// to an Elastic Load Balancing load balancer, specify the DNS name that is
	// associated with the load balancer. For information about how to get the DNS
	// name, see "DNSName" in the topic AliasTarget (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html).
	//
	// Note the following:
	//
	//    * The configuration for the service that is specified by ServiceId must
	//    include settings for an A record, an AAAA record, or both.
	//
	//    * In the service that is specified by ServiceId, the value of RoutingPolicy
	//    must be WEIGHTED.
	//
	//    * If the service that is specified by ServiceId includes HealthCheckConfig
	//    settings, AWS Cloud Map will create the health check, but it won't associate
	//    the health check with the alias record.
	//
	//    * Auto naming currently doesn't support creating alias records that route
	//    traffic to AWS resources other than ELB load balancers.
	//
	//    * If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values
	//    for any of the AWS_INSTANCE attributes.
	//
	// AWS_EC2_INSTANCE_ID
	//
	// HTTP namespaces only. The Amazon EC2 instance ID for the instance. The AWS_INSTANCE_IPV4
	// attribute contains the primary private IPv4 address.
	//
	// AWS_INSTANCE_CNAME
	//
	// If the service configuration includes a CNAME record, the domain name that
	// you want Route 53 to return in response to DNS queries, for example, example.com.
	//
	// This value is required if the service specified by ServiceId includes settings
	// for an CNAME record.
	//
	// AWS_INSTANCE_IPV4
	//
	// If the service configuration includes an A record, the IPv4 address that
	// you want Route 53 to return in response to DNS queries, for example, 192.0.2.44.
	//
	// This value is required if the service specified by ServiceId includes settings
	// for an A record. If the service includes settings for an SRV record, you
	// must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
	//
	// AWS_INSTANCE_IPV6
	//
	// If the service configuration includes an AAAA record, the IPv6 address that
	// you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.
	//
	// This value is required if the service specified by ServiceId includes settings
	// for an AAAA record. If the service includes settings for an SRV record, you
	// must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
	//
	// AWS_INSTANCE_PORT
	//
	// If the service includes an SRV record, the value that you want Route 53 to
	// return for the port.
	//
	// If the service includes HealthCheckConfig, the port on the endpoint that
	// you want Route 53 to send requests to.
	//
	// This value is required if you specified settings for an SRV record or a Route
	// 53 health check when you created the service.
	Attributes map[string]*string `type:"map"`

	// A unique string that identifies the request and that allows failed RegisterInstance
	// requests to be retried without the risk of executing the operation twice.
	// You must use a unique CreatorRequestId string every time you submit a RegisterInstance
	// request if you're registering additional instances for the same namespace
	// and service. CreatorRequestId can be any unique string, for example, a date/time
	// stamp.
	CreatorRequestId *string `type:"string"`

	// An identifier that you want to associate with the instance. Note the following:
	//
	//    * If the service that is specified by ServiceId includes settings for
	//    an SRV record, the value of InstanceId is automatically included as part
	//    of the value for the SRV record. For more information, see DnsRecord >
	//    Type (https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type).
	//
	//    * You can use this value to update an existing instance.
	//
	//    * To register a new instance, you must specify a value that is unique
	//    among instances that you register by using the same service.
	//
	//    * If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates
	//    the existing DNS records. If there's also an existing health check, AWS
	//    Cloud Map deletes the old health check and creates a new one. The health
	//    check isn't deleted immediately, so it will still appear for a while if
	//    you submit a ListHealthChecks request, for example.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A complex type that contains information about an instance that AWS Cloud Map creates when you submit a RegisterInstance request.

func (Instance) GoString 

func (s Instance) GoString() string

GoString returns the string representation

func (*Instance) SetAttributes 

func (s *Instance) SetAttributes(v map[string]*string) *Instance

SetAttributes sets the Attributes field's value.

func (*Instance) SetCreatorRequestId 

func (s *Instance) SetCreatorRequestId(v string) *Instance

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*Instance) SetId 

func (s *Instance) SetId(v string) *Instance

SetId sets the Id field's value.

func (Instance) String 

func (s Instance) String() string

String returns the string representation

type InstanceNotFound added in v1.28.0 

type InstanceNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InstanceNotFound) Code added in v1.28.0 

func (s *InstanceNotFound) Code() string

Code returns the exception type name.

func (*InstanceNotFound) Error added in v1.28.0 

func (s *InstanceNotFound) Error() string

func (InstanceNotFound) GoString added in v1.28.0 

func (s InstanceNotFound) GoString() string

GoString returns the string representation

func (*InstanceNotFound) Message added in v1.28.0 

func (s *InstanceNotFound) Message() string

Message returns the exception's message.

func (*InstanceNotFound) OrigErr added in v1.28.0 

func (s *InstanceNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InstanceNotFound) RequestID added in v1.28.0 

func (s *InstanceNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InstanceNotFound) StatusCode added in v1.28.0 

func (s *InstanceNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InstanceNotFound) String added in v1.28.0 

func (s InstanceNotFound) String() string

String returns the string representation

type InstanceSummary 

type InstanceSummary struct {

	// A string map that contains the following information:
	//
	//    * The attributes that are associate with the instance.
	//
	//    * For each attribute, the applicable value.
	//
	// Supported attribute keys include the following:
	//
	//    * AWS_ALIAS_DNS_NAME: For an alias record that routes traffic to an Elastic
	//    Load Balancing load balancer, the DNS name that is associated with the
	//    load balancer.
	//
	//    * AWS_EC2_INSTANCE_ID: (HTTP namespaces only) The Amazon EC2 instance
	//    ID for the instance. When the AWS_EC2_INSTANCE_ID attribute is specified,
	//    then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4
	//    address.
	//
	//    * AWS_INSTANCE_CNAME: For a CNAME record, the domain name that Route 53
	//    returns in response to DNS queries, for example, example.com.
	//
	//    * AWS_INSTANCE_IPV4: For an A record, the IPv4 address that Route 53 returns
	//    in response to DNS queries, for example, 192.0.2.44.
	//
	//    * AWS_INSTANCE_IPV6: For an AAAA record, the IPv6 address that Route 53
	//    returns in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.
	//
	//    * AWS_INSTANCE_PORT: For an SRV record, the value that Route 53 returns
	//    for the port. In addition, if the service includes HealthCheckConfig,
	//    the port on the endpoint that Route 53 sends requests to.
	Attributes map[string]*string `type:"map"`

	// The ID for an instance that you created by using a specified service.
	Id *string `type:"string"`
	// contains filtered or unexported fields
}

A complex type that contains information about the instances that you registered by using a specified service.

func (InstanceSummary) GoString 

func (s InstanceSummary) GoString() string

GoString returns the string representation

func (*InstanceSummary) SetAttributes 

func (s *InstanceSummary) SetAttributes(v map[string]*string) *InstanceSummary

SetAttributes sets the Attributes field's value.

func (*InstanceSummary) SetId 

func (s *InstanceSummary) SetId(v string) *InstanceSummary

SetId sets the Id field's value.

func (InstanceSummary) String 

func (s InstanceSummary) String() string

String returns the string representation

type InvalidInput added in v1.28.0 

type InvalidInput struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*InvalidInput) Code added in v1.28.0 

func (s *InvalidInput) Code() string

Code returns the exception type name.

func (*InvalidInput) Error added in v1.28.0 

func (s *InvalidInput) Error() string

func (InvalidInput) GoString added in v1.28.0 

func (s InvalidInput) GoString() string

GoString returns the string representation

func (*InvalidInput) Message added in v1.28.0 

func (s *InvalidInput) Message() string

Message returns the exception's message.

func (*InvalidInput) OrigErr added in v1.28.0 

func (s *InvalidInput) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidInput) RequestID added in v1.28.0 

func (s *InvalidInput) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidInput) StatusCode added in v1.28.0 

func (s *InvalidInput) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidInput) String added in v1.28.0 

func (s InvalidInput) String() string

String returns the string representation

type ListInstancesInput 

type ListInstancesInput struct {

	// The maximum number of instances that you want AWS Cloud Map to return in
	// the response to a ListInstances request. If you don't specify a value for
	// MaxResults, AWS Cloud Map returns up to 100 instances.
	MaxResults *int64 `min:"1" type:"integer"`

	// For the first ListInstances request, omit this value.
	//
	// If more than MaxResults instances match the specified criteria, you can submit
	// another ListInstances request to get the next group of results. Specify the
	// value of NextToken from the previous response in the next request.
	NextToken *string `type:"string"`

	// The ID of the service that you want to list instances for.
	//
	// ServiceId is a required field
	ServiceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListInstancesInput) GoString 

func (s ListInstancesInput) GoString() string

GoString returns the string representation

func (*ListInstancesInput) SetMaxResults 

func (s *ListInstancesInput) SetMaxResults(v int64) *ListInstancesInput

SetMaxResults sets the MaxResults field's value.

func (*ListInstancesInput) SetNextToken 

func (s *ListInstancesInput) SetNextToken(v string) *ListInstancesInput

SetNextToken sets the NextToken field's value.

func (*ListInstancesInput) SetServiceId 

func (s *ListInstancesInput) SetServiceId(v string) *ListInstancesInput

SetServiceId sets the ServiceId field's value.

func (ListInstancesInput) String 

func (s ListInstancesInput) String() string

String returns the string representation

func (*ListInstancesInput) Validate 

func (s *ListInstancesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListInstancesOutput 

type ListInstancesOutput struct {

	// Summary information about the instances that are associated with the specified
	// service.
	Instances []*InstanceSummary `type:"list"`

	// If more than MaxResults instances match the specified criteria, you can submit
	// another ListInstances request to get the next group of results. Specify the
	// value of NextToken from the previous response in the next request.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListInstancesOutput) GoString 

func (s ListInstancesOutput) GoString() string

GoString returns the string representation

func (*ListInstancesOutput) SetInstances 

func (s *ListInstancesOutput) SetInstances(v []*InstanceSummary) *ListInstancesOutput

SetInstances sets the Instances field's value.

func (*ListInstancesOutput) SetNextToken 

func (s *ListInstancesOutput) SetNextToken(v string) *ListInstancesOutput

SetNextToken sets the NextToken field's value.

func (ListInstancesOutput) String 

func (s ListInstancesOutput) String() string

String returns the string representation

type ListNamespacesInput 

type ListNamespacesInput struct {

	// A complex type that contains specifications for the namespaces that you want
	// to list.
	//
	// If you specify more than one filter, a namespace must match all filters to
	// be returned by ListNamespaces.
	Filters []*NamespaceFilter `type:"list"`

	// The maximum number of namespaces that you want AWS Cloud Map to return in
	// the response to a ListNamespaces request. If you don't specify a value for
	// MaxResults, AWS Cloud Map returns up to 100 namespaces.
	MaxResults *int64 `min:"1" type:"integer"`

	// For the first ListNamespaces request, omit this value.
	//
	// If the response contains NextToken, submit another ListNamespaces request
	// to get the next group of results. Specify the value of NextToken from the
	// previous response in the next request.
	//
	// AWS Cloud Map gets MaxResults namespaces and then filters them based on the
	// specified criteria. It's possible that no namespaces in the first MaxResults
	// namespaces matched the specified criteria but that subsequent groups of MaxResults
	// namespaces do contain namespaces that match the criteria.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListNamespacesInput) GoString 

func (s ListNamespacesInput) GoString() string

GoString returns the string representation

func (*ListNamespacesInput) SetFilters 

func (s *ListNamespacesInput) SetFilters(v []*NamespaceFilter) *ListNamespacesInput

SetFilters sets the Filters field's value.

func (*ListNamespacesInput) SetMaxResults 

func (s *ListNamespacesInput) SetMaxResults(v int64) *ListNamespacesInput

SetMaxResults sets the MaxResults field's value.

func (*ListNamespacesInput) SetNextToken 

func (s *ListNamespacesInput) SetNextToken(v string) *ListNamespacesInput

SetNextToken sets the NextToken field's value.

func (ListNamespacesInput) String 

func (s ListNamespacesInput) String() string

String returns the string representation

func (*ListNamespacesInput) Validate 

func (s *ListNamespacesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListNamespacesOutput 

type ListNamespacesOutput struct {

	// An array that contains one NamespaceSummary object for each namespace that
	// matches the specified filter criteria.
	Namespaces []*NamespaceSummary `type:"list"`

	// If the response contains NextToken, submit another ListNamespaces request
	// to get the next group of results. Specify the value of NextToken from the
	// previous response in the next request.
	//
	// AWS Cloud Map gets MaxResults namespaces and then filters them based on the
	// specified criteria. It's possible that no namespaces in the first MaxResults
	// namespaces matched the specified criteria but that subsequent groups of MaxResults
	// namespaces do contain namespaces that match the criteria.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListNamespacesOutput) GoString 

func (s ListNamespacesOutput) GoString() string

GoString returns the string representation

func (*ListNamespacesOutput) SetNamespaces 

func (s *ListNamespacesOutput) SetNamespaces(v []*NamespaceSummary) *ListNamespacesOutput

SetNamespaces sets the Namespaces field's value.

func (*ListNamespacesOutput) SetNextToken 

func (s *ListNamespacesOutput) SetNextToken(v string) *ListNamespacesOutput

SetNextToken sets the NextToken field's value.

func (ListNamespacesOutput) String 

func (s ListNamespacesOutput) String() string

String returns the string representation

type ListOperationsInput 

type ListOperationsInput struct {

	// A complex type that contains specifications for the operations that you want
	// to list, for example, operations that you started between a specified start
	// date and end date.
	//
	// If you specify more than one filter, an operation must match all filters
	// to be returned by ListOperations.
	Filters []*OperationFilter `type:"list"`

	// The maximum number of items that you want AWS Cloud Map to return in the
	// response to a ListOperations request. If you don't specify a value for MaxResults,
	// AWS Cloud Map returns up to 100 operations.
	MaxResults *int64 `min:"1" type:"integer"`

	// For the first ListOperations request, omit this value.
	//
	// If the response contains NextToken, submit another ListOperations request
	// to get the next group of results. Specify the value of NextToken from the
	// previous response in the next request.
	//
	// AWS Cloud Map gets MaxResults operations and then filters them based on the
	// specified criteria. It's possible that no operations in the first MaxResults
	// operations matched the specified criteria but that subsequent groups of MaxResults
	// operations do contain operations that match the criteria.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListOperationsInput) GoString 

func (s ListOperationsInput) GoString() string

GoString returns the string representation

func (*ListOperationsInput) SetFilters 

func (s *ListOperationsInput) SetFilters(v []*OperationFilter) *ListOperationsInput

SetFilters sets the Filters field's value.

func (*ListOperationsInput) SetMaxResults 

func (s *ListOperationsInput) SetMaxResults(v int64) *ListOperationsInput

SetMaxResults sets the MaxResults field's value.

func (*ListOperationsInput) SetNextToken 

func (s *ListOperationsInput) SetNextToken(v string) *ListOperationsInput

SetNextToken sets the NextToken field's value.

func (ListOperationsInput) String 

func (s ListOperationsInput) String() string

String returns the string representation

func (*ListOperationsInput) Validate 

func (s *ListOperationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListOperationsOutput 

type ListOperationsOutput struct {

	// If the response contains NextToken, submit another ListOperations request
	// to get the next group of results. Specify the value of NextToken from the
	// previous response in the next request.
	//
	// AWS Cloud Map gets MaxResults operations and then filters them based on the
	// specified criteria. It's possible that no operations in the first MaxResults
	// operations matched the specified criteria but that subsequent groups of MaxResults
	// operations do contain operations that match the criteria.
	NextToken *string `type:"string"`

	// Summary information about the operations that match the specified criteria.
	Operations []*OperationSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListOperationsOutput) GoString 

func (s ListOperationsOutput) GoString() string

GoString returns the string representation

func (*ListOperationsOutput) SetNextToken 

func (s *ListOperationsOutput) SetNextToken(v string) *ListOperationsOutput

SetNextToken sets the NextToken field's value.

func (*ListOperationsOutput) SetOperations 

func (s *ListOperationsOutput) SetOperations(v []*OperationSummary) *ListOperationsOutput

SetOperations sets the Operations field's value.

func (ListOperationsOutput) String 

func (s ListOperationsOutput) String() string

String returns the string representation

type ListServicesInput 

type ListServicesInput struct {

	// A complex type that contains specifications for the namespaces that you want
	// to list services for.
	//
	// If you specify more than one filter, an operation must match all filters
	// to be returned by ListServices.
	Filters []*ServiceFilter `type:"list"`

	// The maximum number of services that you want AWS Cloud Map to return in the
	// response to a ListServices request. If you don't specify a value for MaxResults,
	// AWS Cloud Map returns up to 100 services.
	MaxResults *int64 `min:"1" type:"integer"`

	// For the first ListServices request, omit this value.
	//
	// If the response contains NextToken, submit another ListServices request to
	// get the next group of results. Specify the value of NextToken from the previous
	// response in the next request.
	//
	// AWS Cloud Map gets MaxResults services and then filters them based on the
	// specified criteria. It's possible that no services in the first MaxResults
	// services matched the specified criteria but that subsequent groups of MaxResults
	// services do contain services that match the criteria.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListServicesInput) GoString 

func (s ListServicesInput) GoString() string

GoString returns the string representation

func (*ListServicesInput) SetFilters 

func (s *ListServicesInput) SetFilters(v []*ServiceFilter) *ListServicesInput

SetFilters sets the Filters field's value.

func (*ListServicesInput) SetMaxResults 

func (s *ListServicesInput) SetMaxResults(v int64) *ListServicesInput

SetMaxResults sets the MaxResults field's value.

func (*ListServicesInput) SetNextToken 

func (s *ListServicesInput) SetNextToken(v string) *ListServicesInput

SetNextToken sets the NextToken field's value.

func (ListServicesInput) String 

func (s ListServicesInput) String() string

String returns the string representation

func (*ListServicesInput) Validate 

func (s *ListServicesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListServicesOutput 

type ListServicesOutput struct {

	// If the response contains NextToken, submit another ListServices request to
	// get the next group of results. Specify the value of NextToken from the previous
	// response in the next request.
	//
	// AWS Cloud Map gets MaxResults services and then filters them based on the
	// specified criteria. It's possible that no services in the first MaxResults
	// services matched the specified criteria but that subsequent groups of MaxResults
	// services do contain services that match the criteria.
	NextToken *string `type:"string"`

	// An array that contains one ServiceSummary object for each service that matches
	// the specified filter criteria.
	Services []*ServiceSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListServicesOutput) GoString 

func (s ListServicesOutput) GoString() string

GoString returns the string representation

func (*ListServicesOutput) SetNextToken 

func (s *ListServicesOutput) SetNextToken(v string) *ListServicesOutput

SetNextToken sets the NextToken field's value.

func (*ListServicesOutput) SetServices 

func (s *ListServicesOutput) SetServices(v []*ServiceSummary) *ListServicesOutput

SetServices sets the Services field's value.

func (ListServicesOutput) String 

func (s ListServicesOutput) String() string

String returns the string representation

type ListTagsForResourceInput added in v1.31.13 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to retrieve
	// tags for.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.31.13 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceARN added in v1.31.13 

func (s *ListTagsForResourceInput) SetResourceARN(v string) *ListTagsForResourceInput

SetResourceARN sets the ResourceARN field's value.

func (ListTagsForResourceInput) String added in v1.31.13 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v1.31.13 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.31.13 

type ListTagsForResourceOutput struct {

	// The tags that are assigned to the resource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.31.13 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags added in v1.31.13 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.31.13 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type Namespace 

type Namespace struct {

	// The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace
	// when you create it.
	Arn *string `type:"string"`

	// The date that the namespace was created, in Unix date/time format and Coordinated
	// Universal Time (UTC). The value of CreateDate is accurate to milliseconds.
	// For example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	CreateDate *time.Time `type:"timestamp"`

	// A unique string that identifies the request and that allows failed requests
	// to be retried without the risk of executing an operation twice.
	CreatorRequestId *string `type:"string"`

	// The description that you specify for the namespace when you create it.
	Description *string `type:"string"`

	// The ID of a namespace.
	Id *string `type:"string"`

	// The name of the namespace, such as example.com.
	Name *string `type:"string"`

	// A complex type that contains information that's specific to the type of the
	// namespace.
	Properties *NamespaceProperties `type:"structure"`

	// The number of services that are associated with the namespace.
	ServiceCount *int64 `type:"integer"`

	// The type of the namespace. The methods for discovering instances depends
	// on the value that you specify:
	//
	//    * HTTP: Instances can be discovered only programmatically, using the AWS
	//    Cloud Map DiscoverInstances API.
	//
	//    * DNS_PUBLIC: Instances can be discovered using public DNS queries and
	//    using the DiscoverInstances API.
	//
	//    * DNS_PRIVATE: Instances can be discovered using DNS queries in VPCs and
	//    using the DiscoverInstances API.
	Type *string `type:"string" enum:"NamespaceType"`
	// contains filtered or unexported fields
}

A complex type that contains information about a specified namespace.

func (Namespace) GoString 

func (s Namespace) GoString() string

GoString returns the string representation

func (*Namespace) SetArn 

func (s *Namespace) SetArn(v string) *Namespace

SetArn sets the Arn field's value.

func (*Namespace) SetCreateDate 

func (s *Namespace) SetCreateDate(v time.Time) *Namespace

SetCreateDate sets the CreateDate field's value.

func (*Namespace) SetCreatorRequestId 

func (s *Namespace) SetCreatorRequestId(v string) *Namespace

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*Namespace) SetDescription 

func (s *Namespace) SetDescription(v string) *Namespace

SetDescription sets the Description field's value.

func (*Namespace) SetId 

func (s *Namespace) SetId(v string) *Namespace

SetId sets the Id field's value.

func (*Namespace) SetName 

func (s *Namespace) SetName(v string) *Namespace

SetName sets the Name field's value.

func (*Namespace) SetProperties 

func (s *Namespace) SetProperties(v *NamespaceProperties) *Namespace

SetProperties sets the Properties field's value.

func (*Namespace) SetServiceCount 

func (s *Namespace) SetServiceCount(v int64) *Namespace

SetServiceCount sets the ServiceCount field's value.

func (*Namespace) SetType 

func (s *Namespace) SetType(v string) *Namespace

SetType sets the Type field's value.

func (Namespace) String 

func (s Namespace) String() string

String returns the string representation

type NamespaceAlreadyExists added in v1.28.0 

type NamespaceAlreadyExists struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The CreatorRequestId that was used to create the namespace.
	CreatorRequestId *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	// The ID of the existing namespace.
	NamespaceId *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (*NamespaceAlreadyExists) Code added in v1.28.0 

func (s *NamespaceAlreadyExists) Code() string

Code returns the exception type name.

func (*NamespaceAlreadyExists) Error added in v1.28.0 

func (s *NamespaceAlreadyExists) Error() string

func (NamespaceAlreadyExists) GoString added in v1.28.0 

func (s NamespaceAlreadyExists) GoString() string

GoString returns the string representation

func (*NamespaceAlreadyExists) Message added in v1.28.0 

func (s *NamespaceAlreadyExists) Message() string

Message returns the exception's message.

func (*NamespaceAlreadyExists) OrigErr added in v1.28.0 

func (s *NamespaceAlreadyExists) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NamespaceAlreadyExists) RequestID added in v1.28.0 

func (s *NamespaceAlreadyExists) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NamespaceAlreadyExists) StatusCode added in v1.28.0 

func (s *NamespaceAlreadyExists) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NamespaceAlreadyExists) String added in v1.28.0 

func (s NamespaceAlreadyExists) String() string

String returns the string representation

type NamespaceFilter 

type NamespaceFilter struct {

	// The operator that you want to use to determine whether ListNamespaces returns
	// a namespace. Valid values for condition include:
	//
	//    * EQ: When you specify EQ for the condition, you can choose to list only
	//    public namespaces or private namespaces, but not both. EQ is the default
	//    condition and can be omitted.
	//
	//    * IN: When you specify IN for the condition, you can choose to list public
	//    namespaces, private namespaces, or both.
	//
	//    * BETWEEN: Not applicable
	Condition *string `type:"string" enum:"FilterCondition"`

	// Specify TYPE.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"NamespaceFilterName"`

	// If you specify EQ for Condition, specify either DNS_PUBLIC or DNS_PRIVATE.
	//
	// If you specify IN for Condition, you can specify DNS_PUBLIC, DNS_PRIVATE,
	// or both.
	//
	// Values is a required field
	Values []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.

func (NamespaceFilter) GoString 

func (s NamespaceFilter) GoString() string

GoString returns the string representation

func (*NamespaceFilter) SetCondition 

func (s *NamespaceFilter) SetCondition(v string) *NamespaceFilter

SetCondition sets the Condition field's value.

func (*NamespaceFilter) SetName 

func (s *NamespaceFilter) SetName(v string) *NamespaceFilter

SetName sets the Name field's value.

func (*NamespaceFilter) SetValues 

func (s *NamespaceFilter) SetValues(v []*string) *NamespaceFilter

SetValues sets the Values field's value.

func (NamespaceFilter) String 

func (s NamespaceFilter) String() string

String returns the string representation

func (*NamespaceFilter) Validate 

func (s *NamespaceFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NamespaceNotFound added in v1.28.0 

type NamespaceNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

No namespace exists with the specified ID.

func (*NamespaceNotFound) Code added in v1.28.0 

func (s *NamespaceNotFound) Code() string

Code returns the exception type name.

func (*NamespaceNotFound) Error added in v1.28.0 

func (s *NamespaceNotFound) Error() string

func (NamespaceNotFound) GoString added in v1.28.0 

func (s NamespaceNotFound) GoString() string

GoString returns the string representation

func (*NamespaceNotFound) Message added in v1.28.0 

func (s *NamespaceNotFound) Message() string

Message returns the exception's message.

func (*NamespaceNotFound) OrigErr added in v1.28.0 

func (s *NamespaceNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NamespaceNotFound) RequestID added in v1.28.0 

func (s *NamespaceNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NamespaceNotFound) StatusCode added in v1.28.0 

func (s *NamespaceNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NamespaceNotFound) String added in v1.28.0 

func (s NamespaceNotFound) String() string

String returns the string representation

type NamespaceProperties 

type NamespaceProperties struct {

	// A complex type that contains the ID for the Route 53 hosted zone that AWS
	// Cloud Map creates when you create a namespace.
	DnsProperties *DnsProperties `type:"structure"`

	// A complex type that contains the name of an HTTP namespace.
	HttpProperties *HttpProperties `type:"structure"`
	// contains filtered or unexported fields
}

A complex type that contains information that is specific to the namespace type.

func (NamespaceProperties) GoString 

func (s NamespaceProperties) GoString() string

GoString returns the string representation

func (*NamespaceProperties) SetDnsProperties 

func (s *NamespaceProperties) SetDnsProperties(v *DnsProperties) *NamespaceProperties

SetDnsProperties sets the DnsProperties field's value.

func (*NamespaceProperties) SetHttpProperties added in v1.15.86 

func (s *NamespaceProperties) SetHttpProperties(v *HttpProperties) *NamespaceProperties

SetHttpProperties sets the HttpProperties field's value.

func (NamespaceProperties) String 

func (s NamespaceProperties) String() string

String returns the string representation

type NamespaceSummary 

type NamespaceSummary struct {

	// The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace
	// when you create it.
	Arn *string `type:"string"`

	// The date and time that the namespace was created.
	CreateDate *time.Time `type:"timestamp"`

	// A description for the namespace.
	Description *string `type:"string"`

	// The ID of the namespace.
	Id *string `type:"string"`

	// The name of the namespace. When you create a namespace, AWS Cloud Map automatically
	// creates a Route 53 hosted zone that has the same name as the namespace.
	Name *string `type:"string"`

	// A complex type that contains information that is specific to the namespace
	// type.
	Properties *NamespaceProperties `type:"structure"`

	// The number of services that were created using the namespace.
	ServiceCount *int64 `type:"integer"`

	// The type of the namespace, either public or private.
	Type *string `type:"string" enum:"NamespaceType"`
	// contains filtered or unexported fields
}

A complex type that contains information about a namespace.

func (NamespaceSummary) GoString 

func (s NamespaceSummary) GoString() string

GoString returns the string representation

func (*NamespaceSummary) SetArn 

func (s *NamespaceSummary) SetArn(v string) *NamespaceSummary

SetArn sets the Arn field's value.

func (*NamespaceSummary) SetCreateDate added in v1.15.86 

func (s *NamespaceSummary) SetCreateDate(v time.Time) *NamespaceSummary

SetCreateDate sets the CreateDate field's value.

func (*NamespaceSummary) SetDescription added in v1.15.86 

func (s *NamespaceSummary) SetDescription(v string) *NamespaceSummary

SetDescription sets the Description field's value.

func (*NamespaceSummary) SetId 

func (s *NamespaceSummary) SetId(v string) *NamespaceSummary

SetId sets the Id field's value.

func (*NamespaceSummary) SetName 

func (s *NamespaceSummary) SetName(v string) *NamespaceSummary

SetName sets the Name field's value.

func (*NamespaceSummary) SetProperties added in v1.15.86 

func (s *NamespaceSummary) SetProperties(v *NamespaceProperties) *NamespaceSummary

SetProperties sets the Properties field's value.

func (*NamespaceSummary) SetServiceCount added in v1.15.86 

func (s *NamespaceSummary) SetServiceCount(v int64) *NamespaceSummary

SetServiceCount sets the ServiceCount field's value.

func (*NamespaceSummary) SetType 

func (s *NamespaceSummary) SetType(v string) *NamespaceSummary

SetType sets the Type field's value.

func (NamespaceSummary) String 

func (s NamespaceSummary) String() string

String returns the string representation

type Operation 

type Operation struct {

	// The date and time that the request was submitted, in Unix date/time format
	// and Coordinated Universal Time (UTC). The value of CreateDate is accurate
	// to milliseconds. For example, the value 1516925490.087 represents Friday,
	// January 26, 2018 12:11:30.087 AM.
	CreateDate *time.Time `type:"timestamp"`

	// The code associated with ErrorMessage. Values for ErrorCode include the following:
	//
	//    * ACCESS_DENIED
	//
	//    * CANNOT_CREATE_HOSTED_ZONE
	//
	//    * EXPIRED_TOKEN
	//
	//    * HOSTED_ZONE_NOT_FOUND
	//
	//    * INTERNAL_FAILURE
	//
	//    * INVALID_CHANGE_BATCH
	//
	//    * THROTTLED_REQUEST
	ErrorCode *string `type:"string"`

	// If the value of Status is FAIL, the reason that the operation failed.
	ErrorMessage *string `type:"string"`

	// The ID of the operation that you want to get information about.
	Id *string `type:"string"`

	// The status of the operation. Values include the following:
	//
	//    * SUBMITTED: This is the initial state immediately after you submit a
	//    request.
	//
	//    * PENDING: AWS Cloud Map is performing the operation.
	//
	//    * SUCCESS: The operation succeeded.
	//
	//    * FAIL: The operation failed. For the failure reason, see ErrorMessage.
	Status *string `type:"string" enum:"OperationStatus"`

	// The name of the target entity that is associated with the operation:
	//
	//    * NAMESPACE: The namespace ID is returned in the ResourceId property.
	//
	//    * SERVICE: The service ID is returned in the ResourceId property.
	//
	//    * INSTANCE: The instance ID is returned in the ResourceId property.
	Targets map[string]*string `type:"map"`

	// The name of the operation that is associated with the specified ID.
	Type *string `type:"string" enum:"OperationType"`

	// The date and time that the value of Status changed to the current value,
	// in Unix date/time format and Coordinated Universal Time (UTC). The value
	// of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087
	// represents Friday, January 26, 2018 12:11:30.087 AM.
	UpdateDate *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

A complex type that contains information about a specified operation.

func (Operation) GoString 

func (s Operation) GoString() string

GoString returns the string representation

func (*Operation) SetCreateDate 

func (s *Operation) SetCreateDate(v time.Time) *Operation

SetCreateDate sets the CreateDate field's value.

func (*Operation) SetErrorCode 

func (s *Operation) SetErrorCode(v string) *Operation

SetErrorCode sets the ErrorCode field's value.

func (*Operation) SetErrorMessage 

func (s *Operation) SetErrorMessage(v string) *Operation

SetErrorMessage sets the ErrorMessage field's value.

func (*Operation) SetId 

func (s *Operation) SetId(v string) *Operation

SetId sets the Id field's value.

func (*Operation) SetStatus 

func (s *Operation) SetStatus(v string) *Operation

SetStatus sets the Status field's value.

func (*Operation) SetTargets 

func (s *Operation) SetTargets(v map[string]*string) *Operation

SetTargets sets the Targets field's value.

func (*Operation) SetType 

func (s *Operation) SetType(v string) *Operation

SetType sets the Type field's value.

func (*Operation) SetUpdateDate 

func (s *Operation) SetUpdateDate(v time.Time) *Operation

SetUpdateDate sets the UpdateDate field's value.

func (Operation) String 

func (s Operation) String() string

String returns the string representation

type OperationFilter 

type OperationFilter struct {

	// The operator that you want to use to determine whether an operation matches
	// the specified value. Valid values for condition include:
	//
	//    * EQ: When you specify EQ for the condition, you can specify only one
	//    value. EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE.
	//    EQ is the default condition and can be omitted.
	//
	//    * IN: When you specify IN for the condition, you can specify a list of
	//    one or more values. IN is supported for STATUS and TYPE. An operation
	//    must match one of the specified values to be returned in the response.
	//
	//    * BETWEEN: Specify a start date and an end date in Unix date/time format
	//    and Coordinated Universal Time (UTC). The start date must be the first
	//    value. BETWEEN is supported for UPDATE_DATE.
	Condition *string `type:"string" enum:"FilterCondition"`

	// Specify the operations that you want to get:
	//
	//    * NAMESPACE_ID: Gets operations related to specified namespaces.
	//
	//    * SERVICE_ID: Gets operations related to specified services.
	//
	//    * STATUS: Gets operations based on the status of the operations: SUBMITTED,
	//    PENDING, SUCCEED, or FAIL.
	//
	//    * TYPE: Gets specified types of operation.
	//
	//    * UPDATE_DATE: Gets operations that changed status during a specified
	//    date/time range.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"OperationFilterName"`

	// Specify values that are applicable to the value that you specify for Name:
	//
	//    * NAMESPACE_ID: Specify one namespace ID.
	//
	//    * SERVICE_ID: Specify one service ID.
	//
	//    * STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED, or
	//    FAIL.
	//
	//    * TYPE: Specify one or more of the following types: CREATE_NAMESPACE,
	//    DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_INSTANCE.
	//
	//    * UPDATE_DATE: Specify a start date and an end date in Unix date/time
	//    format and Coordinated Universal Time (UTC). The start date must be the
	//    first value.
	//
	// Values is a required field
	Values []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

A complex type that lets you select the operations that you want to list.

func (OperationFilter) GoString 

func (s OperationFilter) GoString() string

GoString returns the string representation

func (*OperationFilter) SetCondition 

func (s *OperationFilter) SetCondition(v string) *OperationFilter

SetCondition sets the Condition field's value.

func (*OperationFilter) SetName 

func (s *OperationFilter) SetName(v string) *OperationFilter

SetName sets the Name field's value.

func (*OperationFilter) SetValues 

func (s *OperationFilter) SetValues(v []*string) *OperationFilter

SetValues sets the Values field's value.

func (OperationFilter) String 

func (s OperationFilter) String() string

String returns the string representation

func (*OperationFilter) Validate 

func (s *OperationFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type OperationNotFound added in v1.28.0 

type OperationNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

No operation exists with the specified ID.

func (*OperationNotFound) Code added in v1.28.0 

func (s *OperationNotFound) Code() string

Code returns the exception type name.

func (*OperationNotFound) Error added in v1.28.0 

func (s *OperationNotFound) Error() string

func (OperationNotFound) GoString added in v1.28.0 

func (s OperationNotFound) GoString() string

GoString returns the string representation

func (*OperationNotFound) Message added in v1.28.0 

func (s *OperationNotFound) Message() string

Message returns the exception's message.

func (*OperationNotFound) OrigErr added in v1.28.0 

func (s *OperationNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*OperationNotFound) RequestID added in v1.28.0 

func (s *OperationNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*OperationNotFound) StatusCode added in v1.28.0 

func (s *OperationNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (OperationNotFound) String added in v1.28.0 

func (s OperationNotFound) String() string

String returns the string representation

type OperationSummary 

type OperationSummary struct {

	// The ID for an operation.
	Id *string `type:"string"`

	// The status of the operation. Values include the following:
	//
	//    * SUBMITTED: This is the initial state immediately after you submit a
	//    request.
	//
	//    * PENDING: AWS Cloud Map is performing the operation.
	//
	//    * SUCCESS: The operation succeeded.
	//
	//    * FAIL: The operation failed. For the failure reason, see ErrorMessage.
	Status *string `type:"string" enum:"OperationStatus"`
	// contains filtered or unexported fields
}

A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations (https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html) request.

func (OperationSummary) GoString 

func (s OperationSummary) GoString() string

GoString returns the string representation

func (*OperationSummary) SetId 

func (s *OperationSummary) SetId(v string) *OperationSummary

SetId sets the Id field's value.

func (*OperationSummary) SetStatus 

func (s *OperationSummary) SetStatus(v string) *OperationSummary

SetStatus sets the Status field's value.

func (OperationSummary) String 

func (s OperationSummary) String() string

String returns the string representation

type RegisterInstanceInput 

type RegisterInstanceInput struct {

	// A string map that contains the following information for the service that
	// you specify in ServiceId:
	//
	//    * The attributes that apply to the records that are defined in the service.
	//
	//    * For each attribute, the applicable value.
	//
	// Supported attribute keys include the following:
	//
	// AWS_ALIAS_DNS_NAME
	//
	// If you want AWS Cloud Map to create an Amazon Route 53 alias record that
	// routes traffic to an Elastic Load Balancing load balancer, specify the DNS
	// name that is associated with the load balancer. For information about how
	// to get the DNS name, see "DNSName" in the topic AliasTarget (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html)
	// in the Route 53 API Reference.
	//
	// Note the following:
	//
	//    * The configuration for the service that is specified by ServiceId must
	//    include settings for an A record, an AAAA record, or both.
	//
	//    * In the service that is specified by ServiceId, the value of RoutingPolicy
	//    must be WEIGHTED.
	//
	//    * If the service that is specified by ServiceId includes HealthCheckConfig
	//    settings, AWS Cloud Map will create the Route 53 health check, but it
	//    won't associate the health check with the alias record.
	//
	//    * Auto naming currently doesn't support creating alias records that route
	//    traffic to AWS resources other than Elastic Load Balancing load balancers.
	//
	//    * If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values
	//    for any of the AWS_INSTANCE attributes.
	//
	// AWS_EC2_INSTANCE_ID
	//
	// HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the
	// AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute
	// that can be specified is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID
	// attribute is specified, then the AWS_INSTANCE_IPV4 attribute will be filled
	// out with the primary private IPv4 address.
	//
	// AWS_INIT_HEALTH_STATUS
	//
	// If the service configuration includes HealthCheckCustomConfig, you can optionally
	// use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health
	// check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS,
	// the initial status is HEALTHY.
	//
	// AWS_INSTANCE_CNAME
	//
	// If the service configuration includes a CNAME record, the domain name that
	// you want Route 53 to return in response to DNS queries, for example, example.com.
	//
	// This value is required if the service specified by ServiceId includes settings
	// for an CNAME record.
	//
	// AWS_INSTANCE_IPV4
	//
	// If the service configuration includes an A record, the IPv4 address that
	// you want Route 53 to return in response to DNS queries, for example, 192.0.2.44.
	//
	// This value is required if the service specified by ServiceId includes settings
	// for an A record. If the service includes settings for an SRV record, you
	// must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
	//
	// AWS_INSTANCE_IPV6
	//
	// If the service configuration includes an AAAA record, the IPv6 address that
	// you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.
	//
	// This value is required if the service specified by ServiceId includes settings
	// for an AAAA record. If the service includes settings for an SRV record, you
	// must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.
	//
	// AWS_INSTANCE_PORT
	//
	// If the service includes an SRV record, the value that you want Route 53 to
	// return for the port.
	//
	// If the service includes HealthCheckConfig, the port on the endpoint that
	// you want Route 53 to send requests to.
	//
	// This value is required if you specified settings for an SRV record or a Route
	// 53 health check when you created the service.
	//
	// Custom attributes
	//
	// You can add up to 30 custom attributes. For each key-value pair, the maximum
	// length of the attribute name is 255 characters, and the maximum length of
	// the attribute value is 1,024 characters. The total size of all provided attributes
	// (sum of all keys and values) must not exceed 5,000 characters.
	//
	// Attributes is a required field
	Attributes map[string]*string `type:"map" required:"true"`

	// A unique string that identifies the request and that allows failed RegisterInstance
	// requests to be retried without the risk of executing the operation twice.
	// You must use a unique CreatorRequestId string every time you submit a RegisterInstance
	// request if you're registering additional instances for the same namespace
	// and service. CreatorRequestId can be any unique string, for example, a date/time
	// stamp.
	CreatorRequestId *string `type:"string" idempotencyToken:"true"`

	// An identifier that you want to associate with the instance. Note the following:
	//
	//    * If the service that is specified by ServiceId includes settings for
	//    an SRV record, the value of InstanceId is automatically included as part
	//    of the value for the SRV record. For more information, see DnsRecord >
	//    Type (https://docs.aws.amazon.com/cloud-map/latest/api/API_DnsRecord.html#cloudmap-Type-DnsRecord-Type).
	//
	//    * You can use this value to update an existing instance.
	//
	//    * To register a new instance, you must specify a value that is unique
	//    among instances that you register by using the same service.
	//
	//    * If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates
	//    the existing DNS records, if any. If there's also an existing health check,
	//    AWS Cloud Map deletes the old health check and creates a new one. The
	//    health check isn't deleted immediately, so it will still appear for a
	//    while if you submit a ListHealthChecks request, for example.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The ID of the service that you want to use for settings for the instance.
	//
	// ServiceId is a required field
	ServiceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RegisterInstanceInput) GoString 

func (s RegisterInstanceInput) GoString() string

GoString returns the string representation

func (*RegisterInstanceInput) SetAttributes 

func (s *RegisterInstanceInput) SetAttributes(v map[string]*string) *RegisterInstanceInput

SetAttributes sets the Attributes field's value.

func (*RegisterInstanceInput) SetCreatorRequestId 

func (s *RegisterInstanceInput) SetCreatorRequestId(v string) *RegisterInstanceInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*RegisterInstanceInput) SetInstanceId 

func (s *RegisterInstanceInput) SetInstanceId(v string) *RegisterInstanceInput

SetInstanceId sets the InstanceId field's value.

func (*RegisterInstanceInput) SetServiceId 

func (s *RegisterInstanceInput) SetServiceId(v string) *RegisterInstanceInput

SetServiceId sets the ServiceId field's value.

func (RegisterInstanceInput) String 

func (s RegisterInstanceInput) String() string

String returns the string representation

func (*RegisterInstanceInput) Validate 

func (s *RegisterInstanceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterInstanceOutput 

type RegisterInstanceOutput struct {

	// A value that you can use to determine whether the request completed successfully.
	// To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html).
	OperationId *string `type:"string"`
	// contains filtered or unexported fields
}

func (RegisterInstanceOutput) GoString 

func (s RegisterInstanceOutput) GoString() string

GoString returns the string representation

func (*RegisterInstanceOutput) SetOperationId 

func (s *RegisterInstanceOutput) SetOperationId(v string) *RegisterInstanceOutput

SetOperationId sets the OperationId field's value.

func (RegisterInstanceOutput) String 

func (s RegisterInstanceOutput) String() string

String returns the string representation

type RequestLimitExceeded added in v1.31.13 

type RequestLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation can't be completed because you've reached the quota for the number of requests. For more information, see AWS Cloud Map API request throttling quota (https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html) in the AWS Cloud Map Developer Guide.

func (*RequestLimitExceeded) Code added in v1.31.13 

func (s *RequestLimitExceeded) Code() string

Code returns the exception type name.

func (*RequestLimitExceeded) Error added in v1.31.13 

func (s *RequestLimitExceeded) Error() string

func (RequestLimitExceeded) GoString added in v1.31.13 

func (s RequestLimitExceeded) GoString() string

GoString returns the string representation

func (*RequestLimitExceeded) Message added in v1.31.13 

func (s *RequestLimitExceeded) Message() string

Message returns the exception's message.

func (*RequestLimitExceeded) OrigErr added in v1.31.13 

func (s *RequestLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestLimitExceeded) RequestID added in v1.31.13 

func (s *RequestLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestLimitExceeded) StatusCode added in v1.31.13 

func (s *RequestLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RequestLimitExceeded) String added in v1.31.13 

func (s RequestLimitExceeded) String() string

String returns the string representation

type ResourceInUse added in v1.28.0 

type ResourceInUse struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceInUse) Code added in v1.28.0 

func (s *ResourceInUse) Code() string

Code returns the exception type name.

func (*ResourceInUse) Error added in v1.28.0 

func (s *ResourceInUse) Error() string

func (ResourceInUse) GoString added in v1.28.0 

func (s ResourceInUse) GoString() string

GoString returns the string representation

func (*ResourceInUse) Message added in v1.28.0 

func (s *ResourceInUse) Message() string

Message returns the exception's message.

func (*ResourceInUse) OrigErr added in v1.28.0 

func (s *ResourceInUse) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUse) RequestID added in v1.28.0 

func (s *ResourceInUse) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUse) StatusCode added in v1.28.0 

func (s *ResourceInUse) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceInUse) String added in v1.28.0 

func (s ResourceInUse) String() string

String returns the string representation

type ResourceLimitExceeded added in v1.28.0 

type ResourceLimitExceeded struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceLimitExceeded) Code added in v1.28.0 

func (s *ResourceLimitExceeded) Code() string

Code returns the exception type name.

func (*ResourceLimitExceeded) Error added in v1.28.0 

func (s *ResourceLimitExceeded) Error() string

func (ResourceLimitExceeded) GoString added in v1.28.0 

func (s ResourceLimitExceeded) GoString() string

GoString returns the string representation

func (*ResourceLimitExceeded) Message added in v1.28.0 

func (s *ResourceLimitExceeded) Message() string

Message returns the exception's message.

func (*ResourceLimitExceeded) OrigErr added in v1.28.0 

func (s *ResourceLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceLimitExceeded) RequestID added in v1.28.0 

func (s *ResourceLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceLimitExceeded) StatusCode added in v1.28.0 

func (s *ResourceLimitExceeded) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceLimitExceeded) String added in v1.28.0 

func (s ResourceLimitExceeded) String() string

String returns the string representation

type ResourceNotFoundException added in v1.31.13 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation can't be completed because the resource was not found.

func (*ResourceNotFoundException) Code added in v1.31.13 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.31.13 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.31.13 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.31.13 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.31.13 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.31.13 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.31.13 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.31.13 

func (s ResourceNotFoundException) String() string

String returns the string representation

type Service 

type Service struct {

	// The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service
	// when you create it.
	Arn *string `type:"string"`

	// The date and time that the service was created, in Unix format and Coordinated
	// Universal Time (UTC). The value of CreateDate is accurate to milliseconds.
	// For example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	CreateDate *time.Time `type:"timestamp"`

	// A unique string that identifies the request and that allows failed requests
	// to be retried without the risk of executing the operation twice. CreatorRequestId
	// can be any unique string, for example, a date/time stamp.
	CreatorRequestId *string `type:"string"`

	// The description of the service.
	Description *string `type:"string"`

	// A complex type that contains information about the Route 53 DNS records that
	// you want AWS Cloud Map to create when you register an instance.
	DnsConfig *DnsConfig `type:"structure"`

	// Public DNS and HTTP namespaces only. A complex type that contains settings
	// for an optional health check. If you specify settings for a health check,
	// AWS Cloud Map associates the health check with the records that you specify
	// in DnsConfig.
	//
	// For information about the charges for health checks, see Amazon Route 53
	// Pricing (http://aws.amazon.com/route53/pricing/).
	HealthCheckConfig *HealthCheckConfig `type:"structure"`

	// A complex type that contains information about an optional custom health
	// check.
	//
	// If you specify a health check configuration, you can specify either HealthCheckCustomConfig
	// or HealthCheckConfig but not both.
	HealthCheckCustomConfig *HealthCheckCustomConfig `type:"structure"`

	// The ID that AWS Cloud Map assigned to the service when you created it.
	Id *string `type:"string"`

	// The number of instances that are currently associated with the service. Instances
	// that were previously associated with the service but that have been deleted
	// are not included in the count. The count might not reflect pending registrations
	// and deregistrations.
	InstanceCount *int64 `type:"integer"`

	// The name of the service.
	Name *string `type:"string"`

	// The ID of the namespace that was used to create the service.
	NamespaceId *string `type:"string"`

	// Describes the systems that can be used to discover the service instances.
	//
	// DNS_HTTP
	//
	// The service instances can be discovered using either DNS queries or the DiscoverInstances
	// API operation.
	//
	// HTTP
	//
	// The service instances can only be discovered using the DiscoverInstances
	// API operation.
	//
	// DNS
	//
	// Reserved.
	Type *string `type:"string" enum:"ServiceType"`
	// contains filtered or unexported fields
}

A complex type that contains information about the specified service.

func (Service) GoString 

func (s Service) GoString() string

GoString returns the string representation

func (*Service) SetArn 

func (s *Service) SetArn(v string) *Service

SetArn sets the Arn field's value.

func (*Service) SetCreateDate 

func (s *Service) SetCreateDate(v time.Time) *Service

SetCreateDate sets the CreateDate field's value.

func (*Service) SetCreatorRequestId 

func (s *Service) SetCreatorRequestId(v string) *Service

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*Service) SetDescription 

func (s *Service) SetDescription(v string) *Service

SetDescription sets the Description field's value.

func (*Service) SetDnsConfig 

func (s *Service) SetDnsConfig(v *DnsConfig) *Service

SetDnsConfig sets the DnsConfig field's value.

func (*Service) SetHealthCheckConfig 

func (s *Service) SetHealthCheckConfig(v *HealthCheckConfig) *Service

SetHealthCheckConfig sets the HealthCheckConfig field's value.

func (*Service) SetHealthCheckCustomConfig added in v1.13.13 

func (s *Service) SetHealthCheckCustomConfig(v *HealthCheckCustomConfig) *Service

SetHealthCheckCustomConfig sets the HealthCheckCustomConfig field's value.

func (*Service) SetId 

func (s *Service) SetId(v string) *Service

SetId sets the Id field's value.

func (*Service) SetInstanceCount 

func (s *Service) SetInstanceCount(v int64) *Service

SetInstanceCount sets the InstanceCount field's value.

func (*Service) SetName 

func (s *Service) SetName(v string) *Service

SetName sets the Name field's value.

func (*Service) SetNamespaceId added in v1.15.86 

func (s *Service) SetNamespaceId(v string) *Service

SetNamespaceId sets the NamespaceId field's value.

func (*Service) SetType added in v1.37.24 

func (s *Service) SetType(v string) *Service

SetType sets the Type field's value.

func (Service) String 

func (s Service) String() string

String returns the string representation

type ServiceAlreadyExists added in v1.28.0 

type ServiceAlreadyExists struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The CreatorRequestId that was used to create the service.
	CreatorRequestId *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	// The ID of the existing service.
	ServiceId *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (*ServiceAlreadyExists) Code added in v1.28.0 

func (s *ServiceAlreadyExists) Code() string

Code returns the exception type name.

func (*ServiceAlreadyExists) Error added in v1.28.0 

func (s *ServiceAlreadyExists) Error() string

func (ServiceAlreadyExists) GoString added in v1.28.0 

func (s ServiceAlreadyExists) GoString() string

GoString returns the string representation

func (*ServiceAlreadyExists) Message added in v1.28.0 

func (s *ServiceAlreadyExists) Message() string

Message returns the exception's message.

func (*ServiceAlreadyExists) OrigErr added in v1.28.0 

func (s *ServiceAlreadyExists) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceAlreadyExists) RequestID added in v1.28.0 

func (s *ServiceAlreadyExists) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceAlreadyExists) StatusCode added in v1.28.0 

func (s *ServiceAlreadyExists) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceAlreadyExists) String added in v1.28.0 

func (s ServiceAlreadyExists) String() string

String returns the string representation

type ServiceChange 

type ServiceChange struct {

	// A description for the service.
	Description *string `type:"string"`

	// A complex type that contains information about the Route 53 DNS records that
	// you want AWS Cloud Map to create when you register an instance.
	DnsConfig *DnsConfigChange `type:"structure"`

	// Public DNS and HTTP namespaces only. A complex type that contains settings
	// for an optional health check. If you specify settings for a health check,
	// AWS Cloud Map associates the health check with the records that you specify
	// in DnsConfig.
	//
	// If you specify a health check configuration, you can specify either HealthCheckCustomConfig
	// or HealthCheckConfig but not both.
	//
	// Health checks are basic Route 53 health checks that monitor an AWS endpoint.
	// For information about pricing for health checks, see Amazon Route 53 Pricing
	// (http://aws.amazon.com/route53/pricing/).
	//
	// Note the following about configuring health checks.
	//
	//  A and AAAA records
	//
	// If DnsConfig includes configurations for both A and AAAA records, AWS Cloud
	// Map creates a health check that uses the IPv4 address to check the health
	// of the resource. If the endpoint that is specified by the IPv4 address is
	// unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.
	//
	//  CNAME records
	//
	// You can't specify settings for HealthCheckConfig when the DNSConfig includes
	// CNAME for the value of Type. If you do, the CreateService request will fail
	// with an InvalidInput error.
	//
	// Request interval
	//
	// A Route 53 health checker in each health-checking region sends a health check
	// request to an endpoint every 30 seconds. On average, your endpoint receives
	// a health check request about every two seconds. However, health checkers
	// don't coordinate with one another, so you'll sometimes see several requests
	// per second followed by a few seconds with no health checks at all.
	//
	// Health checking regions
	//
	// Health checkers perform checks from all Route 53 health-checking regions.
	// For a list of the current regions, see Regions (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions).
	//
	// Alias records
	//
	// When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute,
	// AWS Cloud Map creates a Route 53 alias record. Note the following:
	//
	//    * Route 53 automatically sets EvaluateTargetHealth to true for alias records.
	//    When EvaluateTargetHealth is true, the alias record inherits the health
	//    of the referenced AWS resource. such as an ELB load balancer. For more
	//    information, see EvaluateTargetHealth (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth).
	//
	//    * If you include HealthCheckConfig and then use the service to register
	//    an instance that creates an alias record, Route 53 doesn't create the
	//    health check.
	//
	// Charges for health checks
	//
	// Health checks are basic Route 53 health checks that monitor an AWS endpoint.
	// For information about pricing for health checks, see Amazon Route 53 Pricing
	// (http://aws.amazon.com/route53/pricing/).
	HealthCheckConfig *HealthCheckConfig `type:"structure"`
	// contains filtered or unexported fields
}

A complex type that contains changes to an existing service.

func (ServiceChange) GoString 

func (s ServiceChange) GoString() string

GoString returns the string representation

func (*ServiceChange) SetDescription 

func (s *ServiceChange) SetDescription(v string) *ServiceChange

SetDescription sets the Description field's value.

func (*ServiceChange) SetDnsConfig 

func (s *ServiceChange) SetDnsConfig(v *DnsConfigChange) *ServiceChange

SetDnsConfig sets the DnsConfig field's value.

func (*ServiceChange) SetHealthCheckConfig 

func (s *ServiceChange) SetHealthCheckConfig(v *HealthCheckConfig) *ServiceChange

SetHealthCheckConfig sets the HealthCheckConfig field's value.

func (ServiceChange) String 

func (s ServiceChange) String() string

String returns the string representation

func (*ServiceChange) Validate 

func (s *ServiceChange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ServiceDiscovery

New creates a new instance of the ServiceDiscovery client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a ServiceDiscovery client from just a session.
svc := servicediscovery.New(mySession)

// Create a ServiceDiscovery client with additional configuration
svc := servicediscovery.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ServiceDiscovery) CreateHttpNamespace added in v1.15.86 

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 quota on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map quotas (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 Types:

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

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

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

  • DuplicateRequest The operation is already in progress.

  • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.

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

Example (Shared00)

CreateHttpNamespace example

This example creates an HTTP namespace. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.CreateHttpNamespaceInput{
		CreatorRequestId: aws.String("example-creator-request-id-0001"),
		Description:      aws.String("Example.com AWS Cloud Map HTTP Namespace"),
		Name:             aws.String("example-http.com"),
	}

	result, err := svc.CreateHttpNamespace(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeNamespaceAlreadyExists:
				fmt.Println(servicediscovery.ErrCodeNamespaceAlreadyExists, aerr.Error())
			case servicediscovery.ErrCodeResourceLimitExceeded:
				fmt.Println(servicediscovery.ErrCodeResourceLimitExceeded, aerr.Error())
			case servicediscovery.ErrCodeDuplicateRequest:
				fmt.Println(servicediscovery.ErrCodeDuplicateRequest, aerr.Error())
			case servicediscovery.ErrCodeTooManyTagsException:
				fmt.Println(servicediscovery.ErrCodeTooManyTagsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) CreateHttpNamespaceRequest added in v1.15.86 

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

func (*ServiceDiscovery) CreateHttpNamespaceWithContext added in v1.15.86 

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.

func (*ServiceDiscovery) 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 quota 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 Types:

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

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

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

  • DuplicateRequest The operation is already in progress.

  • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.

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

Example (Shared00)

Example: Create private DNS namespace

Example: Create private DNS namespace 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.CreatePrivateDnsNamespaceInput{
		CreatorRequestId: aws.String("eedd6892-50f3-41b2-8af9-611d6e1d1a8c"),
		Name:             aws.String("example.com"),
		Vpc:              aws.String("vpc-1c56417b"),
	}

	result, err := svc.CreatePrivateDnsNamespace(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeNamespaceAlreadyExists:
				fmt.Println(servicediscovery.ErrCodeNamespaceAlreadyExists, aerr.Error())
			case servicediscovery.ErrCodeResourceLimitExceeded:
				fmt.Println(servicediscovery.ErrCodeResourceLimitExceeded, aerr.Error())
			case servicediscovery.ErrCodeDuplicateRequest:
				fmt.Println(servicediscovery.ErrCodeDuplicateRequest, aerr.Error())
			case servicediscovery.ErrCodeTooManyTagsException:
				fmt.Println(servicediscovery.ErrCodeTooManyTagsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 quota 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 Types:

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

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

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

  • DuplicateRequest The operation is already in progress.

  • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.

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

Example (Shared00)

CreatePublicDnsNamespace example

This example creates a public namespace based on DNS. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.CreatePublicDnsNamespaceInput{
		CreatorRequestId: aws.String("example-creator-request-id-0003"),
		Description:      aws.String("Example.com AWS Cloud Map Public DNS Namespace"),
		Name:             aws.String("example-public-dns.com"),
	}

	result, err := svc.CreatePublicDnsNamespace(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeNamespaceAlreadyExists:
				fmt.Println(servicediscovery.ErrCodeNamespaceAlreadyExists, aerr.Error())
			case servicediscovery.ErrCodeResourceLimitExceeded:
				fmt.Println(servicediscovery.ErrCodeResourceLimitExceeded, aerr.Error())
			case servicediscovery.ErrCodeDuplicateRequest:
				fmt.Println(servicediscovery.ErrCodeDuplicateRequest, aerr.Error())
			case servicediscovery.ErrCodeTooManyTagsException:
				fmt.Println(servicediscovery.ErrCodeTooManyTagsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 (https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html) request, and AWS Cloud Map uses the values in the configuration to create the specified entities.

For the current quota on the number of instances that you can register using the same namespace and using the same service, see 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 Types:

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

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

  • NamespaceNotFound No namespace exists with the specified ID.

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

  • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.

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

Example (Shared00)

Example: Create service

Example: Create service 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.CreateServiceInput{
		CreatorRequestId: aws.String("567c1193-6b00-4308-bd57-ad38a8822d25"),
		DnsConfig: &servicediscovery.DnsConfig{
			DnsRecords: []*servicediscovery.DnsRecord{
				{
					TTL:  aws.Int64(60),
					Type: aws.String("A"),
				},
			},
			NamespaceId:   aws.String("ns-ylexjili4cdxy3xm"),
			RoutingPolicy: aws.String("MULTIVALUE"),
		},
		Name:        aws.String("myservice"),
		NamespaceId: aws.String("ns-ylexjili4cdxy3xm"),
	}

	result, err := svc.CreateService(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeResourceLimitExceeded:
				fmt.Println(servicediscovery.ErrCodeResourceLimitExceeded, aerr.Error())
			case servicediscovery.ErrCodeNamespaceNotFound:
				fmt.Println(servicediscovery.ErrCodeNamespaceNotFound, aerr.Error())
			case servicediscovery.ErrCodeServiceAlreadyExists:
				fmt.Println(servicediscovery.ErrCodeServiceAlreadyExists, aerr.Error())
			case servicediscovery.ErrCodeTooManyTagsException:
				fmt.Println(servicediscovery.ErrCodeTooManyTagsException, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 Types:

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

  • NamespaceNotFound No namespace exists with the specified ID.

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

  • DuplicateRequest The operation is already in progress.

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

Example (Shared00)

Example: Delete namespace

Example: Delete namespace 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.DeleteNamespaceInput{
		Id: aws.String("ns-ylexjili4cdxy3xm"),
	}

	result, err := svc.DeleteNamespace(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeNamespaceNotFound:
				fmt.Println(servicediscovery.ErrCodeNamespaceNotFound, aerr.Error())
			case servicediscovery.ErrCodeResourceInUse:
				fmt.Println(servicediscovery.ErrCodeResourceInUse, aerr.Error())
			case servicediscovery.ErrCodeDuplicateRequest:
				fmt.Println(servicediscovery.ErrCodeDuplicateRequest, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 Types:

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

  • ServiceNotFound No service exists with the specified ID.

  • 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

Example (Shared00)

Example: Delete service

Example: Delete service 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.DeleteServiceInput{
		Id: aws.String("srv-p5zdwlg5uvvzjita"),
	}

	result, err := svc.DeleteService(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeServiceNotFound:
				fmt.Println(servicediscovery.ErrCodeServiceNotFound, aerr.Error())
			case servicediscovery.ErrCodeResourceInUse:
				fmt.Println(servicediscovery.ErrCodeResourceInUse, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 Types:

  • DuplicateRequest The operation is already in progress.

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

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

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

  • ServiceNotFound No service exists with the specified ID.

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

Example (Shared00)

Example: Deregister a service instance

Example: Deregister a service instance 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.DeregisterInstanceInput{
		InstanceId: aws.String("myservice-53"),
		ServiceId:  aws.String("srv-p5zdwlg5uvvzjita"),
	}

	result, err := svc.DeregisterInstance(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeDuplicateRequest:
				fmt.Println(servicediscovery.ErrCodeDuplicateRequest, aerr.Error())
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeInstanceNotFound:
				fmt.Println(servicediscovery.ErrCodeInstanceNotFound, aerr.Error())
			case servicediscovery.ErrCodeResourceInUse:
				fmt.Println(servicediscovery.ErrCodeResourceInUse, aerr.Error())
			case servicediscovery.ErrCodeServiceNotFound:
				fmt.Println(servicediscovery.ErrCodeServiceNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) DiscoverInstances added in v1.15.86 

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

DiscoverInstances API operation for AWS Cloud Map.

Discovers registered instances for a specified namespace and service. You can use DiscoverInstances to discover instances for any type of namespace. For public and private DNS namespaces, you can also use DNS queries to discover instances.

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

  • ServiceNotFound No service exists with the specified ID.

  • NamespaceNotFound No namespace exists with the specified ID.

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

  • RequestLimitExceeded The operation can't be completed because you've reached the quota for the number of requests. For more information, see AWS Cloud Map API request throttling quota (https://docs.aws.amazon.com/cloud-map/latest/dg/throttling.html) in the AWS Cloud Map Developer Guide.

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

Example (Shared00)

Example: Discover registered instances

Example: Discover registered instances 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.DiscoverInstancesInput{
		HealthStatus:  aws.String("ALL"),
		MaxResults:    aws.Int64(10),
		NamespaceName: aws.String("example.com"),
		ServiceName:   aws.String("myservice"),
	}

	result, err := svc.DiscoverInstances(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeServiceNotFound:
				fmt.Println(servicediscovery.ErrCodeServiceNotFound, aerr.Error())
			case servicediscovery.ErrCodeNamespaceNotFound:
				fmt.Println(servicediscovery.ErrCodeNamespaceNotFound, aerr.Error())
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeRequestLimitExceeded:
				fmt.Println(servicediscovery.ErrCodeRequestLimitExceeded, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) DiscoverInstancesRequest added in v1.15.86 

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

func (*ServiceDiscovery) DiscoverInstancesWithContext added in v1.15.86 

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.

func (*ServiceDiscovery) 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 Types:

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

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

  • ServiceNotFound No service exists with the specified ID.

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

Example (Shared00)

GetInstance example

This example gets information about a specified instance. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.GetInstanceInput{
		InstanceId: aws.String("i-abcd1234"),
		ServiceId:  aws.String("srv-e4anhexample0004"),
	}

	result, err := svc.GetInstance(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInstanceNotFound:
				fmt.Println(servicediscovery.ErrCodeInstanceNotFound, aerr.Error())
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeServiceNotFound:
				fmt.Println(servicediscovery.ErrCodeServiceNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 Types:

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

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

  • ServiceNotFound No service exists with the specified ID.

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

Example (Shared00)

GetInstancesHealthStatus example

This example gets the current health status of one or more instances that are associate with a specified service. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.GetInstancesHealthStatusInput{
		ServiceId: aws.String("srv-e4anhexample0004"),
	}

	result, err := svc.GetInstancesHealthStatus(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInstanceNotFound:
				fmt.Println(servicediscovery.ErrCodeInstanceNotFound, aerr.Error())
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeServiceNotFound:
				fmt.Println(servicediscovery.ErrCodeServiceNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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 *servicediscovery.GetInstancesHealthStatusOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 Types:

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

  • NamespaceNotFound No namespace exists with the specified ID.

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

Example (Shared00)

GetNamespace example

This example gets information about a specified namespace. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.GetNamespaceInput{
		Id: aws.String("ns-e4anhexample0004"),
	}

	result, err := svc.GetNamespace(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeNamespaceNotFound:
				fmt.Println(servicediscovery.ErrCodeNamespaceNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 (https://docs.aws.amazon.com/cloud-map/latest/api/API_ListOperations.html).

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

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

  • OperationNotFound No operation exists with the specified ID.

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

Example (Shared00)

Example: Get operation result

Example: Get operation result 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.GetOperationInput{
		OperationId: aws.String("gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd"),
	}

	result, err := svc.GetOperation(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeOperationNotFound:
				fmt.Println(servicediscovery.ErrCodeOperationNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 Types:

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

  • ServiceNotFound No service exists with the specified ID.

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

Example (Shared00)

GetService Example

This example gets the settings for a specified service. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.GetServiceInput{
		Id: aws.String("srv-e4anhexample0004"),
	}

	result, err := svc.GetService(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeServiceNotFound:
				fmt.Println(servicediscovery.ErrCodeServiceNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 Types:

  • ServiceNotFound No service exists with the specified ID.

  • 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

Example (Shared00)

Example: List service instances

Example: List service instances 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.ListInstancesInput{
		ServiceId: aws.String("srv-qzpwvt2tfqcegapy"),
	}

	result, err := svc.ListInstances(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeServiceNotFound:
				fmt.Println(servicediscovery.ErrCodeServiceNotFound, aerr.Error())
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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 *servicediscovery.ListInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 Types:

  • 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

Example (Shared00)

Example: List namespaces

Example: List namespaces 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.ListNamespacesInput{}

	result, err := svc.ListNamespaces(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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 *servicediscovery.ListNamespacesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 Types:

  • 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

Example (Shared00)

ListOperations Example

This example gets the operations that have a STATUS of either PENDING or SUCCESS. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.ListOperationsInput{
		Filters: []*servicediscovery.OperationFilter{
			{
				Condition: aws.String("IN"),
				Name:      aws.String("STATUS"),
				Values: []*string{
					aws.String("PENDING"),
					aws.String("SUCCESS"),
				},
			},
		},
	}

	result, err := svc.ListOperations(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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 *servicediscovery.ListOperationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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 Types:

  • 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

Example (Shared00)

Example: List services

Example: List services 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.ListServicesInput{}

	result, err := svc.ListServices(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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 *servicediscovery.ListServicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) ListTagsForResource added in v1.31.13 

func (c *ServiceDiscovery) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Cloud Map.

Lists tags for the specified resource.

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 ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The operation can't be completed because the resource was not found.

  • 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/ListTagsForResource

Example (Shared00)

ListTagsForResource example

This example lists the tags of a resource. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.ListTagsForResourceInput{
		ResourceARN: aws.String("arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm"),
	}

	result, err := svc.ListTagsForResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeResourceNotFoundException:
				fmt.Println(servicediscovery.ErrCodeResourceNotFoundException, aerr.Error())
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) ListTagsForResourceRequest added in v1.31.13 

func (c *ServiceDiscovery) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource

func (*ServiceDiscovery) ListTagsForResourceWithContext added in v1.31.13 

func (c *ServiceDiscovery) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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.

func (*ServiceDiscovery) 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 (https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html).

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 quota 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 Types:

  • DuplicateRequest The operation is already in progress.

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

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

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

  • ServiceNotFound No service exists with the specified ID.

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

Example (Shared00)

Example: Register Instance

Example: Register Instance 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.RegisterInstanceInput{
		Attributes: map[string]*string{
			"AWS_INSTANCE_IPV4": aws.String("172.2.1.3"),
			"AWS_INSTANCE_PORT": aws.String("808"),
		},
		CreatorRequestId: aws.String("7a48a98a-72e6-4849-bfa7-1a458e030d7b"),
		InstanceId:       aws.String("myservice-53"),
		ServiceId:        aws.String("srv-p5zdwlg5uvvzjita"),
	}

	result, err := svc.RegisterInstance(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeDuplicateRequest:
				fmt.Println(servicediscovery.ErrCodeDuplicateRequest, aerr.Error())
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeResourceInUse:
				fmt.Println(servicediscovery.ErrCodeResourceInUse, aerr.Error())
			case servicediscovery.ErrCodeResourceLimitExceeded:
				fmt.Println(servicediscovery.ErrCodeResourceLimitExceeded, aerr.Error())
			case servicediscovery.ErrCodeServiceNotFound:
				fmt.Println(servicediscovery.ErrCodeServiceNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

func (*ServiceDiscovery) TagResource added in v1.31.13 

func (c *ServiceDiscovery) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Cloud Map.

Adds one or more tags to the specified resource.

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 TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The operation can't be completed because the resource was not found.

  • TooManyTagsException The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.

  • 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/TagResource

Example (Shared00)

TagResource example

This example adds "Department" and "Project" tags to a resource. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.TagResourceInput{
		ResourceARN: aws.String("arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm"),
		Tags: []*servicediscovery.Tag{
			{
				Key:   aws.String("Department"),
				Value: aws.String("Engineering"),
			},
			{
				Key:   aws.String("Project"),
				Value: aws.String("Zeta"),
			},
		},
	}

	result, err := svc.TagResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeResourceNotFoundException:
				fmt.Println(servicediscovery.ErrCodeResourceNotFoundException, aerr.Error())
			case servicediscovery.ErrCodeTooManyTagsException:
				fmt.Println(servicediscovery.ErrCodeTooManyTagsException, aerr.Error())
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) TagResourceRequest added in v1.31.13 

func (c *ServiceDiscovery) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(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/TagResource

func (*ServiceDiscovery) TagResourceWithContext added in v1.31.13 

func (c *ServiceDiscovery) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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.

func (*ServiceDiscovery) UntagResource added in v1.31.13 

func (c *ServiceDiscovery) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Cloud Map.

Removes one or more tags from the specified resource.

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 UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The operation can't be completed because the resource was not found.

  • 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/UntagResource

Example (Shared00)

UntagResource example

This example removes the "Department" and "Project" tags from a resource. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.UntagResourceInput{
		ResourceARN: aws.String("arn:aws:servicediscovery:us-east-1:123456789012:namespace/ns-ylexjili4cdxy3xm"),
		TagKeys: []*string{
			aws.String("Project"),
			aws.String("Department"),
		},
	}

	result, err := svc.UntagResource(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeResourceNotFoundException:
				fmt.Println(servicediscovery.ErrCodeResourceNotFoundException, aerr.Error())
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) UntagResourceRequest added in v1.31.13 

func (c *ServiceDiscovery) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(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/UntagResource

func (*ServiceDiscovery) UntagResourceWithContext added in v1.31.13 

func (c *ServiceDiscovery) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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.

func (*ServiceDiscovery) UpdateInstanceCustomHealthStatus added in v1.13.13 

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 (https://docs.aws.amazon.com/cloud-map/latest/api/API_HealthCheckCustomConfig.html).

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

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

  • ServiceNotFound No service exists with the specified ID.

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

  • 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

Example (Shared00)

UpdateInstanceCustomHealthStatus Example

This example submits a request to change the health status of an instance associated with a service with a custom health check to HEALTHY. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.UpdateInstanceCustomHealthStatusInput{
		InstanceId: aws.String("i-abcd1234"),
		ServiceId:  aws.String("srv-e4anhexample0004"),
		Status:     aws.String("HEALTHY"),
	}

	result, err := svc.UpdateInstanceCustomHealthStatus(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeInstanceNotFound:
				fmt.Println(servicediscovery.ErrCodeInstanceNotFound, aerr.Error())
			case servicediscovery.ErrCodeServiceNotFound:
				fmt.Println(servicediscovery.ErrCodeServiceNotFound, aerr.Error())
			case servicediscovery.ErrCodeCustomHealthNotFound:
				fmt.Println(servicediscovery.ErrCodeCustomHealthNotFound, aerr.Error())
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) UpdateInstanceCustomHealthStatusRequest added in v1.13.13 

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

func (*ServiceDiscovery) UpdateInstanceCustomHealthStatusWithContext added in v1.13.13 

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.

func (*ServiceDiscovery) UpdateService 

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

UpdateService API operation for AWS Cloud Map.

Submits a request to perform the following operations:

  • Update the TTL setting for existing DnsRecords configurations

  • Add, update, or delete HealthCheckConfig for a specified service You can't add, update, or delete a HealthCheckCustomConfig configuration.

For public and private DNS namespaces, note the following:

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

  • If you omit an existing HealthCheckCustomConfig configuration from an UpdateService request, the configuration is not deleted from the service.

When you update settings 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 Types:

  • DuplicateRequest The operation is already in progress.

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

  • ServiceNotFound No service exists with the specified ID.

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

Example (Shared00)

UpdateService Example

This example submits a request to replace the DnsConfig and HealthCheckConfig settings of a specified service. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/servicediscovery"
)

func main() {
	svc := servicediscovery.New(session.New())
	input := &servicediscovery.UpdateServiceInput{
		Id: aws.String("srv-e4anhexample0004"),
		Service: &servicediscovery.ServiceChange{
			DnsConfig: &servicediscovery.DnsConfigChange{
				DnsRecords: []*servicediscovery.DnsRecord{
					{
						TTL:  aws.Int64(60),
						Type: aws.String("A"),
					},
				},
			},
			HealthCheckConfig: &servicediscovery.HealthCheckConfig{
				FailureThreshold: aws.Int64(2),
				ResourcePath:     aws.String("/"),
				Type:             aws.String("HTTP"),
			},
		},
	}

	result, err := svc.UpdateService(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case servicediscovery.ErrCodeDuplicateRequest:
				fmt.Println(servicediscovery.ErrCodeDuplicateRequest, aerr.Error())
			case servicediscovery.ErrCodeInvalidInput:
				fmt.Println(servicediscovery.ErrCodeInvalidInput, aerr.Error())
			case servicediscovery.ErrCodeServiceNotFound:
				fmt.Println(servicediscovery.ErrCodeServiceNotFound, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*ServiceDiscovery) 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

func (*ServiceDiscovery) 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.

type ServiceFilter 

type ServiceFilter struct {

	// The operator that you want to use to determine whether a service is returned
	// by ListServices. Valid values for Condition include the following:
	//
	//    * EQ: When you specify EQ, specify one namespace ID for Values. EQ is
	//    the default condition and can be omitted.
	//
	//    * IN: When you specify IN, specify a list of the IDs for the namespaces
	//    that you want ListServices to return a list of services for.
	//
	//    * BETWEEN: Not applicable.
	Condition *string `type:"string" enum:"FilterCondition"`

	// Specify NAMESPACE_ID.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"ServiceFilterName"`

	// The values that are applicable to the value that you specify for Condition
	// to filter the list of services.
	//
	// Values is a required field
	Values []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

A complex type that lets you specify the namespaces that you want to list services for.

func (ServiceFilter) GoString 

func (s ServiceFilter) GoString() string

GoString returns the string representation

func (*ServiceFilter) SetCondition 

func (s *ServiceFilter) SetCondition(v string) *ServiceFilter

SetCondition sets the Condition field's value.

func (*ServiceFilter) SetName 

func (s *ServiceFilter) SetName(v string) *ServiceFilter

SetName sets the Name field's value.

func (*ServiceFilter) SetValues 

func (s *ServiceFilter) SetValues(v []*string) *ServiceFilter

SetValues sets the Values field's value.

func (ServiceFilter) String 

func (s ServiceFilter) String() string

String returns the string representation

func (*ServiceFilter) Validate 

func (s *ServiceFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceNotFound added in v1.28.0 

type ServiceNotFound struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

No service exists with the specified ID.

func (*ServiceNotFound) Code added in v1.28.0 

func (s *ServiceNotFound) Code() string

Code returns the exception type name.

func (*ServiceNotFound) Error added in v1.28.0 

func (s *ServiceNotFound) Error() string

func (ServiceNotFound) GoString added in v1.28.0 

func (s ServiceNotFound) GoString() string

GoString returns the string representation

func (*ServiceNotFound) Message added in v1.28.0 

func (s *ServiceNotFound) Message() string

Message returns the exception's message.

func (*ServiceNotFound) OrigErr added in v1.28.0 

func (s *ServiceNotFound) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceNotFound) RequestID added in v1.28.0 

func (s *ServiceNotFound) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceNotFound) StatusCode added in v1.28.0 

func (s *ServiceNotFound) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceNotFound) String added in v1.28.0 

func (s ServiceNotFound) String() string

String returns the string representation

type ServiceSummary 

type ServiceSummary struct {

	// The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service
	// when you create it.
	Arn *string `type:"string"`

	// The date and time that the service was created.
	CreateDate *time.Time `type:"timestamp"`

	// The description that you specify when you create the service.
	Description *string `type:"string"`

	// A complex type that contains information about the Amazon Route 53 DNS records
	// that you want AWS Cloud Map to create when you register an instance.
	DnsConfig *DnsConfig `type:"structure"`

	// Public DNS and HTTP namespaces only. A complex type that contains settings
	// for an optional health check. If you specify settings for a health check,
	// AWS Cloud Map associates the health check with the records that you specify
	// in DnsConfig.
	//
	// If you specify a health check configuration, you can specify either HealthCheckCustomConfig
	// or HealthCheckConfig but not both.
	//
	// Health checks are basic Route 53 health checks that monitor an AWS endpoint.
	// For information about pricing for health checks, see Amazon Route 53 Pricing
	// (http://aws.amazon.com/route53/pricing/).
	//
	// Note the following about configuring health checks.
	//
	//  A and AAAA records
	//
	// If DnsConfig includes configurations for both A and AAAA records, AWS Cloud
	// Map creates a health check that uses the IPv4 address to check the health
	// of the resource. If the endpoint that is specified by the IPv4 address is
	// unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.
	//
	//  CNAME records
	//
	// You can't specify settings for HealthCheckConfig when the DNSConfig includes
	// CNAME for the value of Type. If you do, the CreateService request will fail
	// with an InvalidInput error.
	//
	// Request interval
	//
	// A Route 53 health checker in each health-checking region sends a health check
	// request to an endpoint every 30 seconds. On average, your endpoint receives
	// a health check request about every two seconds. However, health checkers
	// don't coordinate with one another, so you'll sometimes see several requests
	// per second followed by a few seconds with no health checks at all.
	//
	// Health checking regions
	//
	// Health checkers perform checks from all Route 53 health-checking regions.
	// For a list of the current regions, see Regions (https://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions).
	//
	// Alias records
	//
	// When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute,
	// AWS Cloud Map creates a Route 53 alias record. Note the following:
	//
	//    * Route 53 automatically sets EvaluateTargetHealth to true for alias records.
	//    When EvaluateTargetHealth is true, the alias record inherits the health
	//    of the referenced AWS resource. such as an ELB load balancer. For more
	//    information, see EvaluateTargetHealth (https://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth).
	//
	//    * If you include HealthCheckConfig and then use the service to register
	//    an instance that creates an alias record, Route 53 doesn't create the
	//    health check.
	//
	// Charges for health checks
	//
	// Health checks are basic Route 53 health checks that monitor an AWS endpoint.
	// For information about pricing for health checks, see Amazon Route 53 Pricing
	// (http://aws.amazon.com/route53/pricing/).
	HealthCheckConfig *HealthCheckConfig `type:"structure"`

	// A complex type that contains information about an optional custom health
	// check. A custom health check, which requires that you use a third-party health
	// checker to evaluate the health of your resources, is useful in the following
	// circumstances:
	//
	//    * You can't use a health check that is defined by HealthCheckConfig because
	//    the resource isn't available over the internet. For example, you can use
	//    a custom health check when the instance is in an Amazon VPC. (To check
	//    the health of resources in a VPC, the health checker must also be in the
	//    VPC.)
	//
	//    * You want to use a third-party health checker regardless of where your
	//    resources are.
	//
	// If you specify a health check configuration, you can specify either HealthCheckCustomConfig
	// or HealthCheckConfig but not both.
	//
	// To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus
	// request. AWS Cloud Map doesn't monitor the status of the resource, it just
	// keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus
	// request.
	//
	// Here's how custom health checks work:
	//
	// You create a service and specify a value for FailureThreshold.
	//
	// The failure threshold indicates the number of 30-second intervals you want
	// AWS Cloud Map to wait between the time that your application sends an UpdateInstanceCustomHealthStatus
	// (https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html)
	// request and the time that AWS Cloud Map stops routing internet traffic to
	// the corresponding resource.
	//
	// You register an instance.
	//
	// You configure a third-party health checker to monitor the resource that is
	// associated with the new instance.
	//
	// AWS Cloud Map doesn't check the health of the resource directly.
	//
	// The third-party health-checker determines that the resource is unhealthy
	// and notifies your application.
	//
	// Your application submits an UpdateInstanceCustomHealthStatus request.
	//
	// AWS Cloud Map waits for (FailureThreshold x 30) seconds.
	//
	// If another UpdateInstanceCustomHealthStatus request doesn't arrive during
	// that time to change the status back to healthy, AWS Cloud Map stops routing
	// traffic to the resource.
	HealthCheckCustomConfig *HealthCheckCustomConfig `type:"structure"`

	// The ID that AWS Cloud Map assigned to the service when you created it.
	Id *string `type:"string"`

	// The number of instances that are currently associated with the service. Instances
	// that were previously associated with the service but that have been deleted
	// are not included in the count. The count might not reflect pending registrations
	// and deregistrations.
	InstanceCount *int64 `type:"integer"`

	// The name of the service.
	Name *string `type:"string"`

	// Describes the systems that can be used to discover the service instances.
	//
	// DNS_HTTP
	//
	// The service instances can be discovered using either DNS queries or the DiscoverInstances
	// API operation.
	//
	// HTTP
	//
	// The service instances can only be discovered using the DiscoverInstances
	// API operation.
	//
	// DNS
	//
	// Reserved.
	Type *string `type:"string" enum:"ServiceType"`
	// contains filtered or unexported fields
}

A complex type that contains information about a specified service.

func (ServiceSummary) GoString 

func (s ServiceSummary) GoString() string

GoString returns the string representation

func (*ServiceSummary) SetArn 

func (s *ServiceSummary) SetArn(v string) *ServiceSummary

SetArn sets the Arn field's value.

func (*ServiceSummary) SetCreateDate added in v1.15.86 

func (s *ServiceSummary) SetCreateDate(v time.Time) *ServiceSummary

SetCreateDate sets the CreateDate field's value.

func (*ServiceSummary) SetDescription 

func (s *ServiceSummary) SetDescription(v string) *ServiceSummary

SetDescription sets the Description field's value.

func (*ServiceSummary) SetDnsConfig added in v1.15.86 

func (s *ServiceSummary) SetDnsConfig(v *DnsConfig) *ServiceSummary

SetDnsConfig sets the DnsConfig field's value.

func (*ServiceSummary) SetHealthCheckConfig added in v1.15.86 

func (s *ServiceSummary) SetHealthCheckConfig(v *HealthCheckConfig) *ServiceSummary

SetHealthCheckConfig sets the HealthCheckConfig field's value.

func (*ServiceSummary) SetHealthCheckCustomConfig added in v1.15.86 

func (s *ServiceSummary) SetHealthCheckCustomConfig(v *HealthCheckCustomConfig) *ServiceSummary

SetHealthCheckCustomConfig sets the HealthCheckCustomConfig field's value.

func (*ServiceSummary) SetId 

func (s *ServiceSummary) SetId(v string) *ServiceSummary

SetId sets the Id field's value.

func (*ServiceSummary) SetInstanceCount 

func (s *ServiceSummary) SetInstanceCount(v int64) *ServiceSummary

SetInstanceCount sets the InstanceCount field's value.

func (*ServiceSummary) SetName 

func (s *ServiceSummary) SetName(v string) *ServiceSummary

SetName sets the Name field's value.

func (*ServiceSummary) SetType added in v1.37.24 

func (s *ServiceSummary) SetType(v string) *ServiceSummary

SetType sets the Type field's value.

func (ServiceSummary) String 

func (s ServiceSummary) String() string

String returns the string representation

type Tag added in v1.31.13 

type Tag struct {

	// The key identifier, or name, of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The string value associated with the key of the tag. You can set the value
	// of a tag to an empty string, but you can't set the value of a tag to null.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A custom key-value pair associated with a resource.

func (Tag) GoString added in v1.31.13 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey added in v1.31.13 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.31.13 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String added in v1.31.13 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.31.13 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput added in v1.31.13 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to retrieve
	// tags for.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The tags to add to the specified resource. Specifying the tag key is required.
	// You can set the value of a tag to an empty string, but you can't set the
	// value of a tag to null.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.31.13 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceARN added in v1.31.13 

func (s *TagResourceInput) SetResourceARN(v string) *TagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*TagResourceInput) SetTags added in v1.31.13 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.31.13 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v1.31.13 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.31.13 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.31.13 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String added in v1.31.13 

func (s TagResourceOutput) String() string

String returns the string representation

type TooManyTagsException added in v1.31.13 

type TooManyTagsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`

	// The name of the resource.
	ResourceName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.

func (*TooManyTagsException) Code added in v1.31.13 

func (s *TooManyTagsException) Code() string

Code returns the exception type name.

func (*TooManyTagsException) Error added in v1.31.13 

func (s *TooManyTagsException) Error() string

func (TooManyTagsException) GoString added in v1.31.13 

func (s TooManyTagsException) GoString() string

GoString returns the string representation

func (*TooManyTagsException) Message added in v1.31.13 

func (s *TooManyTagsException) Message() string

Message returns the exception's message.

func (*TooManyTagsException) OrigErr added in v1.31.13 

func (s *TooManyTagsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTagsException) RequestID added in v1.31.13 

func (s *TooManyTagsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTagsException) StatusCode added in v1.31.13 

func (s *TooManyTagsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyTagsException) String added in v1.31.13 

func (s TooManyTagsException) String() string

String returns the string representation

type UntagResourceInput added in v1.31.13 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource that you want to retrieve
	// tags for.
	//
	// ResourceARN is a required field
	ResourceARN *string `min:"1" type:"string" required:"true"`

	// The tag keys to remove from the specified resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.31.13 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceARN added in v1.31.13 

func (s *UntagResourceInput) SetResourceARN(v string) *UntagResourceInput

SetResourceARN sets the ResourceARN field's value.

func (*UntagResourceInput) SetTagKeys added in v1.31.13 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.31.13 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v1.31.13 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.31.13 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.31.13 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String added in v1.31.13 

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateInstanceCustomHealthStatusInput added in v1.13.13 

type UpdateInstanceCustomHealthStatusInput struct {

	// The ID of the instance that you want to change the health status for.
	//
	// InstanceId is a required field
	InstanceId *string `type:"string" required:"true"`

	// The ID of the service that includes the configuration for the custom health
	// check that you want to change the status for.
	//
	// ServiceId is a required field
	ServiceId *string `type:"string" required:"true"`

	// The new status of the instance, HEALTHY or UNHEALTHY.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"CustomHealthStatus"`
	// contains filtered or unexported fields
}

func (UpdateInstanceCustomHealthStatusInput) GoString added in v1.13.13 

func (s UpdateInstanceCustomHealthStatusInput) GoString() string

GoString returns the string representation

func (*UpdateInstanceCustomHealthStatusInput) SetInstanceId added in v1.13.13 

func (s *UpdateInstanceCustomHealthStatusInput) SetInstanceId(v string) *UpdateInstanceCustomHealthStatusInput

SetInstanceId sets the InstanceId field's value.

func (*UpdateInstanceCustomHealthStatusInput) SetServiceId added in v1.13.13 

func (s *UpdateInstanceCustomHealthStatusInput) SetServiceId(v string) *UpdateInstanceCustomHealthStatusInput

SetServiceId sets the ServiceId field's value.

func (*UpdateInstanceCustomHealthStatusInput) SetStatus added in v1.13.13 

func (s *UpdateInstanceCustomHealthStatusInput) SetStatus(v string) *UpdateInstanceCustomHealthStatusInput

SetStatus sets the Status field's value.

func (UpdateInstanceCustomHealthStatusInput) String added in v1.13.13 

func (s UpdateInstanceCustomHealthStatusInput) String() string

String returns the string representation

func (*UpdateInstanceCustomHealthStatusInput) Validate added in v1.13.13 

func (s *UpdateInstanceCustomHealthStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateInstanceCustomHealthStatusOutput added in v1.13.13 

type UpdateInstanceCustomHealthStatusOutput struct {
	// contains filtered or unexported fields
}

func (UpdateInstanceCustomHealthStatusOutput) GoString added in v1.13.13 

func (s UpdateInstanceCustomHealthStatusOutput) GoString() string

GoString returns the string representation

func (UpdateInstanceCustomHealthStatusOutput) String added in v1.13.13 

func (s UpdateInstanceCustomHealthStatusOutput) String() string

String returns the string representation

type UpdateServiceInput 

type UpdateServiceInput struct {

	// The ID of the service that you want to update.
	//
	// Id is a required field
	Id *string `type:"string" required:"true"`

	// A complex type that contains the new settings for the service.
	//
	// Service is a required field
	Service *ServiceChange `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateServiceInput) GoString 

func (s UpdateServiceInput) GoString() string

GoString returns the string representation

func (*UpdateServiceInput) SetId 

func (s *UpdateServiceInput) SetId(v string) *UpdateServiceInput

SetId sets the Id field's value.

func (*UpdateServiceInput) SetService 

func (s *UpdateServiceInput) SetService(v *ServiceChange) *UpdateServiceInput

SetService sets the Service field's value.

func (UpdateServiceInput) String 

func (s UpdateServiceInput) String() string

String returns the string representation

func (*UpdateServiceInput) Validate 

func (s *UpdateServiceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateServiceOutput 

type UpdateServiceOutput struct {

	// A value that you can use to determine whether the request completed successfully.
	// To get the status of the operation, see GetOperation (https://docs.aws.amazon.com/cloud-map/latest/api/API_GetOperation.html).
	OperationId *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateServiceOutput) GoString 

func (s UpdateServiceOutput) GoString() string

GoString returns the string representation

func (*UpdateServiceOutput) SetOperationId 

func (s *UpdateServiceOutput) SetOperationId(v string) *UpdateServiceOutput

SetOperationId sets the OperationId field's value.

func (UpdateServiceOutput) String 

func (s UpdateServiceOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package servicediscoveryiface provides an interface to enable mocking the AWS Cloud Map service client for testing your code.
 Package servicediscoveryiface provides an interface to enable mocking the AWS Cloud Map service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.