lib/aws-sdk-servicediscovery/client.rb in aws-sdk-servicediscovery-1.0.0 vs lib/aws-sdk-servicediscovery/client.rb in aws-sdk-servicediscovery-1.1.0

- old
+ new

@@ -166,13 +166,14 @@ # The name that you want to assign to this namespace. When you create a # namespace, Amazon Route 53 automatically creates a hosted zone that # has the same name as the namespace. # # @option params [String] :creator_request_id - # An optional parameter that you can use to resolve concurrent creation - # requests. `CreatorRequestId` helps to determine if a specific client - # owns the namespace. + # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # # @option params [String] :description @@ -217,13 +218,14 @@ # # @option params [required, String] :name # The name that you want to assign to this namespace. # # @option params [String] :creator_request_id - # An optional parameter that you can use to resolve concurrent creation - # requests. `CreatorRequestId` helps to determine if a specific client - # owns the namespace. + # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # # @option params [String] :description @@ -252,64 +254,51 @@ def create_public_dns_namespace(params = {}, options = {}) req = build_request(:create_public_dns_namespace, params) req.send_request(options) end - # Creates a service, which defines a template for the following + # Creates a service, which defines the configuration for the following # entities: # - # * One to five resource record sets + # * Up to three records (A, AAAA, and SRV) or one CNAME record # # * Optionally, a health check # # After you create the service, you can submit a RegisterInstance - # request, and Amazon Route 53 uses the values in the template to create - # the specified entities. + # request, and Amazon Route 53 uses the values in the configuration to + # create the specified entities. # # @option params [required, String] :name # The name that you want to assign to the service. # # @option params [String] :creator_request_id - # An optional parameter that you can use to resolve concurrent creation - # requests. `CreatorRequestId` helps to determine if a specific client - # owns the namespace. + # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # # @option params [String] :description # A description for the service. # # @option params [required, Types::DnsConfig] :dns_config - # A complex type that contains information about the resource record - # sets that you want Amazon Route 53 to create when you register an - # instance. + # A complex type that contains information about the records that you + # want Route 53 to create when you register an instance. # # @option params [Types::HealthCheckConfig] :health_check_config # *Public DNS namespaces only.* A complex type that contains settings # for an optional health check. If you specify settings for a health - # check, Amazon Route 53 associates the health check with all the - # resource record sets that you specify in `DnsConfig`. + # check, Route 53 associates the health check with all the records that + # you specify in `DnsConfig`. # - # <note markdown="1"> The health check uses 30 seconds as the request interval. This is the - # number of seconds between the time that each Amazon Route 53 health - # checker gets a response from your endpoint and the time that it sends - # the next health check request. A health checker in each data center - # around the world sends your endpoint a health check request every 30 - # seconds. On average, your endpoint receives a health check request - # about every two seconds. Health checkers in different data centers - # 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. + # For information about the charges for health checks, see [Route 53 + # Pricing][1]. # - # </note> # - # For information about the charges for health checks, see [Amazon Route - # 53 Pricing][1]. # - # - # # [1]: http://aws.amazon.com/route53/pricing # # @return [Types::CreateServiceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateServiceResponse#service #service} => Types::Service @@ -320,19 +309,20 @@ # name: "ServiceName", # required # creator_request_id: "ResourceId", # description: "ResourceDescription", # dns_config: { # required # namespace_id: "ResourceId", # required + # routing_policy: "MULTIVALUE", # accepts MULTIVALUE, WEIGHTED # dns_records: [ # required # { - # type: "SRV", # required, accepts SRV, A, AAAA + # type: "SRV", # required, accepts SRV, A, AAAA, CNAME # ttl: 1, # required # }, # ], # }, # health_check_config: { - # type: "HTTP", # accepts HTTP, HTTPS, TCP + # type: "HTTP", # required, accepts HTTP, HTTPS, TCP # resource_path: "ResourcePath", # failure_threshold: 1, # }, # }) # @@ -342,12 +332,13 @@ # resp.service.arn #=> String # resp.service.name #=> String # resp.service.description #=> String # resp.service.instance_count #=> Integer # resp.service.dns_config.namespace_id #=> String + # resp.service.dns_config.routing_policy #=> String, one of "MULTIVALUE", "WEIGHTED" # resp.service.dns_config.dns_records #=> Array - # resp.service.dns_config.dns_records[0].type #=> String, one of "SRV", "A", "AAAA" + # resp.service.dns_config.dns_records[0].type #=> String, one of "SRV", "A", "AAAA", "CNAME" # resp.service.dns_config.dns_records[0].ttl #=> Integer # resp.service.health_check_config.type #=> String, one of "HTTP", "HTTPS", "TCP" # resp.service.health_check_config.resource_path #=> String # resp.service.health_check_config.failure_threshold #=> Integer # resp.service.create_date #=> Time @@ -412,12 +403,12 @@ def delete_service(params = {}, options = {}) req = build_request(:delete_service, params) req.send_request(options) end - # Deletes the resource record sets and the health check, if any, that - # Amazon Route 53 created for the specified instance. + # Deletes the records and the health check, if any, that Amazon Route 53 + # created for the specified instance. # # @option params [required, String] :service_id # The ID of the service that the instance is associated with. # # @option params [required, String] :instance_id @@ -483,27 +474,35 @@ end # Gets the current health status (`Healthy`, `Unhealthy`, or `Unknown`) # of one or more instances that are associated with a specified service. # + # <note markdown="1"> There is a brief delay between when you register an instance and when + # the health status for the instance is available. + # + # </note> + # # @option params [required, String] :service_id # The ID of the service that the instance is associated with. # # @option params [Array<String>] :instances # An array that contains the IDs of all the instances that you want to - # get the health status for. To get the IDs for the instances that - # you've created by using a specified service, submit a ListInstances - # request. + # get the health status for. # # If you omit `Instances`, Amazon Route 53 returns the health status for # all the instances that are associated with the specified service. # + # <note markdown="1"> To get the IDs for the instances that you've registered by using a + # specified service, submit a ListInstances request. + # + # </note> + # # @option params [Integer] :max_results - # The maximum number of instances that you want Amazon Route 53 to - # return in the response to a `GetInstancesHealthStatus` request. If you - # don't specify a value for `MaxResults`, Amazon Route 53 returns up to - # 100 instances. + # The maximum number of instances that you want Route 53 to return in + # the response to a `GetInstancesHealthStatus` request. If you don't + # specify a value for `MaxResults`, Route 53 returns up to 100 + # instances. # # @option params [String] :next_token # For the first `GetInstancesHealthStatus` request, omit this value. # # If more than `MaxResults` instances match the specified criteria, you @@ -575,13 +574,17 @@ req = build_request(:get_namespace, params) req.send_request(options) end # 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. + # the response, such as a `CreateService` request. # + # <note markdown="1"> To get a list of operations that match specified criteria, see + # ListOperations. + # + # </note> + # # @option params [required, String] :operation_id # The ID of the operation that you want to get more information about. # # @return [Types::GetOperationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -635,12 +638,13 @@ # resp.service.arn #=> String # resp.service.name #=> String # resp.service.description #=> String # resp.service.instance_count #=> Integer # resp.service.dns_config.namespace_id #=> String + # resp.service.dns_config.routing_policy #=> String, one of "MULTIVALUE", "WEIGHTED" # resp.service.dns_config.dns_records #=> Array - # resp.service.dns_config.dns_records[0].type #=> String, one of "SRV", "A", "AAAA" + # resp.service.dns_config.dns_records[0].type #=> String, one of "SRV", "A", "AAAA", "CNAME" # resp.service.dns_config.dns_records[0].ttl #=> Integer # resp.service.health_check_config.type #=> String, one of "HTTP", "HTTPS", "TCP" # resp.service.health_check_config.resource_path #=> String # resp.service.health_check_config.failure_threshold #=> Integer # resp.service.create_date #=> Time @@ -653,12 +657,12 @@ def get_service(params = {}, options = {}) req = build_request(:get_service, params) req.send_request(options) end - # Gets summary information about the instances that you created by using - # a specified service. + # Lists summary information about the instances that you registered by + # using a specified service. # # @option params [required, String] :service_id # The ID of the service that you want to list instances for. # # @option params [String] :next_token @@ -670,11 +674,11 @@ # in the next request. # # @option params [Integer] :max_results # The maximum number of instances that you want Amazon Route 53 to # return in the response to a `ListInstances` request. If you don't - # specify a value for `MaxResults`, Amazon Route 53 returns up to 100 + # specify a value for `MaxResults`, Route 53 returns up to 100 # instances. # # @return [Types::ListInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListInstancesResponse#instances #instances} => Array&lt;Types::InstanceSummary&gt; @@ -703,33 +707,40 @@ def list_instances(params = {}, options = {}) req = build_request(:list_instances, params) req.send_request(options) end - # Gets information about the namespaces that were created by the current - # AWS account. + # Lists summary information about the namespaces that were created by + # the current AWS account. # # @option params [String] :next_token # For the first `ListNamespaces` request, omit this value. # - # If more than `MaxResults` namespaces match the specified criteria, you - # can submit another `ListNamespaces` request to get the next group of - # results. Specify the value of `NextToken` from the previous response - # in the next request. + # 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. # + # <note markdown="1"> Route 53 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. + # + # </note> + # # @option params [Integer] :max_results # The maximum number of namespaces that you want Amazon Route 53 to # return in the response to a `ListNamespaces` request. If you don't - # specify a value for `MaxResults`, Amazon Route 53 returns up to 100 + # specify a value for `MaxResults`, Route 53 returns up to 100 # namespaces. # # @option params [Array<Types::NamespaceFilter>] :filters # A complex type that contains specifications for the namespaces that # you want to list. # - # If you specify more than one filter, an operation must match all - # filters to be returned by ListNamespaces. + # If you specify more than one filter, a namespace must match all + # filters to be returned by `ListNamespaces`. # # @return [Types::ListNamespacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListNamespacesResponse#namespaces #namespaces} => Array&lt;Types::NamespaceSummary&gt; # * {Types::ListNamespacesResponse#next_token #next_token} => String @@ -769,19 +780,26 @@ # Lists operations that match the criteria that you specify. # # @option params [String] :next_token # For the first `ListOperations` request, omit this value. # - # If more than `MaxResults` operations match the specified criteria, you - # can submit another `ListOperations` request to get the next group of - # results. Specify the value of `NextToken` from the previous response - # in the next request. + # 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. # + # <note markdown="1"> Route 53 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. + # + # </note> + # # @option params [Integer] :max_results # The maximum number of items that you want Amazon Route 53 to return in # the response to a `ListOperations` request. If you don't specify a - # value for `MaxResults`, Amazon Route 53 returns up to 100 operations. + # value for `MaxResults`, Route 53 returns up to 100 operations. # # @option params [Array<Types::OperationFilter>] :filters # 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. @@ -822,25 +840,32 @@ def list_operations(params = {}, options = {}) req = build_request(:list_operations, params) req.send_request(options) end - # Gets settings for all the services that are associated with one or - # more specified namespaces. + # Lists summary information for all the services that are associated + # with one or more specified namespaces. # # @option params [String] :next_token # For the first `ListServices` request, omit this value. # - # If more than `MaxResults` services match the specified criteria, you - # can submit another `ListServices` request to get the next group of - # results. Specify the value of `NextToken` from the previous response - # in the next request. + # 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. # + # <note markdown="1"> Route 53 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. + # + # </note> + # # @option params [Integer] :max_results # The maximum number of services that you want Amazon Route 53 to return # in the response to a `ListServices` request. If you don't specify a - # value for `MaxResults`, Amazon Route 53 returns up to 100 services. + # value for `MaxResults`, Route 53 returns up to 100 services. # # @option params [Array<Types::ServiceFilter>] :filters # A complex type that contains specifications for the namespaces that # you want to list services for. # @@ -883,80 +908,162 @@ def list_services(params = {}, options = {}) req = build_request(:list_services, params) req.send_request(options) end - # Creates one or more resource record sets and optionally a health check + # Creates or updates one or more records and optionally a health check # based on the settings in a specified service. When you submit a # `RegisterInstance` request, Amazon Route 53 does the following: # - # * Creates a resource record set for each resource record set template - # in the service + # * For each DNS record that you define in the service specified by + # `ServiceId`, creates or updates a record in the hosted zone that is + # associated with the corresponding namespace # - # * Creates a health check based on the settings in the health check - # template in the service, if any + # * Creates or updates a health check based on the settings in the + # health check configuration, if any, for the service # - # * Associates the health check, if any, with each of the resource - # record sets + # * Associates the health check, if any, with each of the records # # One `RegisterInstance` request must complete before you can submit - # another request and specify the same service and instance ID. + # another request and specify the same service ID and instance ID. # # For more information, see CreateService. # - # When Amazon Route 53 receives a DNS query for the specified DNS name, - # it returns the applicable value: + # When Route 53 receives a DNS query for the specified DNS name, it + # returns the applicable value: # - # * **If the health check is healthy**\: returns all the resource record - # sets + # * **If the health check is healthy**\: returns all the records # # * **If the health check is unhealthy**\: returns the IP address of the # last healthy instance # - # * **If you didn't specify a health check template**\: returns all the - # resource record sets + # * **If you didn't specify a health check configuration**\: returns + # all the records # # @option params [required, String] :service_id # The ID of the service that you want to use for settings for the - # resource record sets and health check that Amazon Route 53 will - # create. + # records and health check that Route 53 will create. # # @option params [required, String] :instance_id # 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. + # # * 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`, Route 53 + # updates the existing records. If there's also an existing health + # check, Route 53 deletes the old health check and creates a new one. + # + # <note markdown="1"> The health check isn't deleted immediately, so it will still appear + # for a while if you submit a `ListHealthChecks` request, for example. + # + # </note> + # # @option params [String] :creator_request_id - # An optional parameter that you can use to resolve concurrent creation - # requests. `CreatorRequestId` helps to determine if a specific client - # owns the namespace. + # 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. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # # @option params [required, Hash<String,String>] :attributes - # A string map that contain attribute keys and values. Supported - # attribute keys include the following: + # A string map that contains the following information for the service + # that you specify in `ServiceId`\: # - # * `AWS_INSTANCE_PORT`\: The port on the endpoint that you want Amazon - # Route 53 to perform health checks on. This value is also used for - # the port value in an SRV record if the service that you specify - # includes an SRV record. For more information, see CreateService. + # * The attributes that apply to the records that are defined in the + # service. # - # * `AWS_INSTANCE_IPV4`\: If the service that you specify contains a - # resource record set template for an A record, the IPv4 address that - # you want Amazon Route 53 to use for the value of the A record. + # * For each attribute, the applicable value. # - # * `AWS_INSTANCE_IPV6`\: If the service that you specify contains a - # resource record set template for an AAAA record, the IPv6 address - # that you want Amazon Route 53 to use for the value of the AAAA - # record. + # Supported attribute keys include the following: # + # **AWS\_ALIAS\_DNS\_NAME** + # + # **** + # + # If you want Route 53 to create an 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][1]. + # + # 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, Route 53 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\_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. Either `AWS_INSTANCE_IPV4` or + # `AWS_INSTANCE_IPV6` is required if the service includes settings for + # an SRV record. + # + # **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. Either `AWS_INSTANCE_IPV4` or + # `AWS_INSTANCE_IPV6` is required if the service includes settings for + # an SRV record. + # + # **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 + # when you created the service. + # + # + # + # [1]: http://docs.aws.amazon.com/http:/docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html + # # @return [Types::RegisterInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RegisterInstanceResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values @@ -981,19 +1088,28 @@ def register_instance(params = {}, options = {}) req = build_request(:register_instance, params) req.send_request(options) end - # Updates the TTL setting for a specified service. You must specify all - # the resource record set templates (and, optionally, a health check - # template) that you want to appear in the updated service. Any current - # resource record set templates (or health check template) that don't - # appear in an `UpdateService` request are deleted. + # Submits a request to perform the following operations: # + # * Add or delete `DnsRecords` configurations + # + # * Update the TTL setting for existing `DnsRecords` configurations + # + # * Add, update, or delete `HealthCheckConfig` for a specified service + # + # * + # + # You must specify all `DnsRecords` configurations (and, optionally, + # `HealthCheckConfig`) that you want to appear in the updated service. + # Any current configurations that don't appear in an `UpdateService` + # request are deleted. + # # When you update the TTL setting for a service, Amazon Route 53 also - # updates the corresponding settings in all the resource record sets and - # health checks that were created by using the specified service. + # updates the corresponding settings in all the records and health + # checks that were created by using the specified service. # # @option params [required, String] :id # The ID of the service that you want to update. # # @option params [required, Types::ServiceChange] :service @@ -1010,17 +1126,17 @@ # service: { # required # description: "ResourceDescription", # dns_config: { # required # dns_records: [ # required # { - # type: "SRV", # required, accepts SRV, A, AAAA + # type: "SRV", # required, accepts SRV, A, AAAA, CNAME # ttl: 1, # required # }, # ], # }, # health_check_config: { - # type: "HTTP", # accepts HTTP, HTTPS, TCP + # type: "HTTP", # required, accepts HTTP, HTTPS, TCP # resource_path: "ResourcePath", # failure_threshold: 1, # }, # }, # }) @@ -1049,10 +1165,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-servicediscovery' - context[:gem_version] = '1.0.0' + context[:gem_version] = '1.1.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated