We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Route53Profiles

Inherits:
AWS.Service show all
Identifier:
route53profiles
API Version:
2018-05-10
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

With Amazon Route 53 Profiles you can share Route 53 configurations with VPCs and AWS accounts

Sending a Request Using Route53Profiles

var route53profiles = new AWS.Route53Profiles();
route53profiles.associateProfile(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Route53Profiles object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var route53profiles = new AWS.Route53Profiles({apiVersion: '2018-05-10'});

You can also set the API version globally in AWS.config.apiVersions using the route53profiles service identifier:

AWS.config.apiVersions = {
  route53profiles: '2018-05-10',
  // other service API versions
};

var route53profiles = new AWS.Route53Profiles();

Version:

  • 2018-05-10

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Route53Profiles(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Route53Profiles object

var route53profiles = new AWS.Route53Profiles({apiVersion: '2018-05-10'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Route53Profiles.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Route53Profiles.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Route53Profiles.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateProfile(params = {}, callback) ⇒ AWS.Request

Associates a Route 53 Profiles profile with a VPC. A VPC can have only one Profile associated with it, but a Profile can be associated with 1000 of VPCs (and you can request a higher quota). For more information, see https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities.

Service Reference:

Examples:

Calling the associateProfile operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ProfileId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
route53profiles.associateProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      A name for the association.

    • ProfileId — (String)

      ID of the Profile.

    • ResourceId — (String)

      The ID of the VPC.

    • Tags — (Array<map>)

      A list of the tag keys and values that you want to identify the Profile association.

      • Key — required — (String)

        Key associated with the Tag.

      • Value — required — (String)

        Value for the Tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProfileAssociation — (map)

        The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.

        • CreationTime — (Date)

          The date and time that the Profile association was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile association.

        • ModificationTime — (Date)

          The date and time that the Profile association was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile association.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile association owner.

        • ProfileId — (String)

          ID of the Profile.

        • ResourceId — (String)

          The Amazon Resource Name (ARN) of the VPC.

        • Status — (String)

          Status of the Profile association.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Additional information about the Profile association.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateResourceToProfile(params = {}, callback) ⇒ AWS.Request

Associates a DNS reource configuration to a Route 53 Profile.

Service Reference:

Examples:

Calling the associateResourceToProfile operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ProfileId: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE', /* required */
  ResourceProperties: 'STRING_VALUE'
};
route53profiles.associateResourceToProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      Name for the resource association.

    • ProfileId — (String)

      ID of the Profile.

    • ResourceArn — (String)

      Amazon resource number, ARN, of the DNS resource.

    • ResourceProperties — (String)

      If you are adding a DNS Firewall rule group, include also a priority. The priority indicates the processing order for the rule groups, starting with the priority assinged the lowest value.

      The allowed values for priority are between 100 and 9900.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProfileResourceAssociation — (map)

        Infromation about the AssociateResourceToProfile, including a status message.

        • CreationTime — (Date)

          The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile resource association.

        • ModificationTime — (Date)

          The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile resource association.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile resource association owner.

        • ProfileId — (String)

          Profile ID of the Profile that the resources are associated with.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the resource association.

        • ResourceProperties — (String)

          If the DNS resource is a DNS Firewall rule group, this indicates the priority.

        • ResourceType — (String)

          Resource type, such as a private hosted zone, or DNS Firewall rule group.

        • Status — (String)

          Status of the Profile resource association.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Additional information about the Profile resource association.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createProfile(params = {}, callback) ⇒ AWS.Request

Creates an empty Route 53 Profile.

Service Reference:

Examples:

Calling the createProfile operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
route53profiles.createProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClientToken — (String)

      ClientToken is an idempotency token that ensures a call to CreateProfile completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from CreateProfile. In this case, safely retry your call to CreateProfile by using the same CreateProfile parameter value.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Name — (String)

      A name for the Profile.

    • Tags — (Array<map>)

      A list of the tag keys and values that you want to associate with the Route 53 Profile.

      • Key — required — (String)

        Key associated with the Tag.

      • Value — required — (String)

        Value for the Tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Profile — (map)

        The Profile that you just created.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the Profile.

        • ClientToken — (String)

          The ClientToken value that was assigned when the Profile was created.

        • CreationTime — (Date)

          The date and time that the Profile was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile.

        • ModificationTime — (Date)

          The date and time that the Profile was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile owner.

        • ShareStatus — (String)

          Sharing status for the Profile.

          Possible values include:
          • "NOT_SHARED"
          • "SHARED_WITH_ME"
          • "SHARED_BY_ME"
        • Status — (String)

          The status for the Profile.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Status message that includes additiona information about the Profile.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteProfile(params = {}, callback) ⇒ AWS.Request

Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.

Service Reference:

Examples:

Calling the deleteProfile operation

var params = {
  ProfileId: 'STRING_VALUE' /* required */
};
route53profiles.deleteProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProfileId — (String)

      The ID of the Profile that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Profile — (map)

        Information about the DeleteProfile request, including the status of the request.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the Profile.

        • ClientToken — (String)

          The ClientToken value that was assigned when the Profile was created.

        • CreationTime — (Date)

          The date and time that the Profile was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile.

        • ModificationTime — (Date)

          The date and time that the Profile was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile owner.

        • ShareStatus — (String)

          Sharing status for the Profile.

          Possible values include:
          • "NOT_SHARED"
          • "SHARED_WITH_ME"
          • "SHARED_BY_ME"
        • Status — (String)

          The status for the Profile.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Status message that includes additiona information about the Profile.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disassociateProfile(params = {}, callback) ⇒ AWS.Request

Dissociates a specified Route 53 Profile from the specified VPC.

Service Reference:

Examples:

Calling the disassociateProfile operation

var params = {
  ProfileId: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE' /* required */
};
route53profiles.disassociateProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProfileId — (String)

      ID of the Profile.

    • ResourceId — (String)

      The ID of the VPC.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProfileAssociation — (map)

        Information about the DisassociateProfile request.

        • CreationTime — (Date)

          The date and time that the Profile association was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile association.

        • ModificationTime — (Date)

          The date and time that the Profile association was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile association.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile association owner.

        • ProfileId — (String)

          ID of the Profile.

        • ResourceId — (String)

          The Amazon Resource Name (ARN) of the VPC.

        • Status — (String)

          Status of the Profile association.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Additional information about the Profile association.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disassociateResourceFromProfile(params = {}, callback) ⇒ AWS.Request

Dissoaciated a specified resource, from the Route 53 Profile.

Service Reference:

Examples:

Calling the disassociateResourceFromProfile operation

var params = {
  ProfileId: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE' /* required */
};
route53profiles.disassociateResourceFromProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProfileId — (String)

      The ID of the Profile.

    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProfileResourceAssociation — (map)

        Information about the DisassociateResourceFromProfile request, including the status of the request.

        • CreationTime — (Date)

          The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile resource association.

        • ModificationTime — (Date)

          The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile resource association.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile resource association owner.

        • ProfileId — (String)

          Profile ID of the Profile that the resources are associated with.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the resource association.

        • ResourceProperties — (String)

          If the DNS resource is a DNS Firewall rule group, this indicates the priority.

        • ResourceType — (String)

          Resource type, such as a private hosted zone, or DNS Firewall rule group.

        • Status — (String)

          Status of the Profile resource association.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Additional information about the Profile resource association.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getProfile(params = {}, callback) ⇒ AWS.Request

Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.

Service Reference:

Examples:

Calling the getProfile operation

var params = {
  ProfileId: 'STRING_VALUE' /* required */
};
route53profiles.getProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProfileId — (String)

      ID of the Profile.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Profile — (map)

        Information about the Profile, including the status of the Profile.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the Profile.

        • ClientToken — (String)

          The ClientToken value that was assigned when the Profile was created.

        • CreationTime — (Date)

          The date and time that the Profile was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile.

        • ModificationTime — (Date)

          The date and time that the Profile was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile owner.

        • ShareStatus — (String)

          Sharing status for the Profile.

          Possible values include:
          • "NOT_SHARED"
          • "SHARED_WITH_ME"
          • "SHARED_BY_ME"
        • Status — (String)

          The status for the Profile.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Status message that includes additiona information about the Profile.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getProfileAssociation(params = {}, callback) ⇒ AWS.Request

Retrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile association, but a Profile can be associated with up to 5000 VPCs.

Service Reference:

Examples:

Calling the getProfileAssociation operation

var params = {
  ProfileAssociationId: 'STRING_VALUE' /* required */
};
route53profiles.getProfileAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProfileAssociationId — (String)

      The identifier of the association you want to get information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProfileAssociation — (map)

        Information about the Profile association that you specified in a GetProfileAssociation request.

        • CreationTime — (Date)

          The date and time that the Profile association was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile association.

        • ModificationTime — (Date)

          The date and time that the Profile association was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile association.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile association owner.

        • ProfileId — (String)

          ID of the Profile.

        • ResourceId — (String)

          The Amazon Resource Name (ARN) of the VPC.

        • Status — (String)

          Status of the Profile association.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Additional information about the Profile association.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getProfileResourceAssociation(params = {}, callback) ⇒ AWS.Request

Returns information about a specified Route 53 Profile resource association.

Service Reference:

Examples:

Calling the getProfileResourceAssociation operation

var params = {
  ProfileResourceAssociationId: 'STRING_VALUE' /* required */
};
route53profiles.getProfileResourceAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProfileResourceAssociationId — (String)

      The ID of the profile resource association that you want to get information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProfileResourceAssociation — (map)

        Information about the Profile resource association that you specified in a GetProfileResourceAssociation request.

        • CreationTime — (Date)

          The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile resource association.

        • ModificationTime — (Date)

          The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile resource association.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile resource association owner.

        • ProfileId — (String)

          Profile ID of the Profile that the resources are associated with.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the resource association.

        • ResourceProperties — (String)

          If the DNS resource is a DNS Firewall rule group, this indicates the priority.

        • ResourceType — (String)

          Resource type, such as a private hosted zone, or DNS Firewall rule group.

        • Status — (String)

          Status of the Profile resource association.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Additional information about the Profile resource association.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listProfileAssociations(params = {}, callback) ⇒ AWS.Request

Lists all the VPCs that the specified Route 53 Profile is associated with.

Service Reference:

Examples:

Calling the listProfileAssociations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProfileId: 'STRING_VALUE',
  ResourceId: 'STRING_VALUE'
};
route53profiles.listProfileAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer)

      The maximum number of objects that you want to return for this request. If more objects are available, in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.

      If you don't specify a value for MaxResults, up to 100 objects are returned.

    • NextToken — (String)

      For the first call to this list request, omit this value.

      When you request a list of objects, at most the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

    • ProfileId — (String)

      ID of the Profile.

    • ResourceId — (String)

      ID of the VPC.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        If more than MaxResults profile associations match the specified criteria, you can submit another ListProfileAssociations request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

      • ProfileAssociations — (Array<map>)

        A complex type that containts settings information about the profile's VPC associations.

        • CreationTime — (Date)

          The date and time that the Profile association was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile association.

        • ModificationTime — (Date)

          The date and time that the Profile association was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile association.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile association owner.

        • ProfileId — (String)

          ID of the Profile.

        • ResourceId — (String)

          The Amazon Resource Name (ARN) of the VPC.

        • Status — (String)

          Status of the Profile association.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Additional information about the Profile association.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listProfileResourceAssociations(params = {}, callback) ⇒ AWS.Request

Lists all the resource associations for the specified Route 53 Profile.

Service Reference:

Examples:

Calling the listProfileResourceAssociations operation

var params = {
  ProfileId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE'
};
route53profiles.listProfileResourceAssociations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer)

      The maximum number of objects that you want to return for this request. If more objects are available, in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.

      If you don't specify a value for MaxResults, up to 100 objects are returned.

    • NextToken — (String)

      For the first call to this list request, omit this value.

      When you request a list of objects, at most the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

    • ProfileId — (String)

      The ID of the Profile.

    • ResourceType — (String)

      ID of a resource if you want information on only one type.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        If more than MaxResults resource associations match the specified criteria, you can submit another ListProfileResourceAssociations request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

      • ProfileResourceAssociations — (Array<map>)

        Information about the profile resource association that you specified in a GetProfileResourceAssociation request.

        • CreationTime — (Date)

          The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile resource association.

        • ModificationTime — (Date)

          The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile resource association.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile resource association owner.

        • ProfileId — (String)

          Profile ID of the Profile that the resources are associated with.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the resource association.

        • ResourceProperties — (String)

          If the DNS resource is a DNS Firewall rule group, this indicates the priority.

        • ResourceType — (String)

          Resource type, such as a private hosted zone, or DNS Firewall rule group.

        • Status — (String)

          Status of the Profile resource association.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Additional information about the Profile resource association.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listProfiles(params = {}, callback) ⇒ AWS.Request

Lists all the Route 53 Profiles associated with your Amazon Web Services account.

Service Reference:

Examples:

Calling the listProfiles operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
route53profiles.listProfiles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer)

      The maximum number of objects that you want to return for this request. If more objects are available, in the response, a NextToken value, which you can use in a subsequent call to get the next batch of objects, is provided.

      If you don't specify a value for MaxResults, up to 100 objects are returned.

    • NextToken — (String)

      For the first call to this list request, omit this value.

      When you request a list of objects, at most the number of objects specified by MaxResults is returned. If more objects are available for retrieval, a NextToken value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String)

        If more than MaxResults resource associations match the specified criteria, you can submit another ListProfiles request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

      • ProfileSummaries — (Array<map>)

        Summary information about the Profiles.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the Profile.

        • Id — (String)

          ID of the Profile.

        • Name — (String)

          Name of the Profile.

        • ShareStatus — (String)

          Share status of the Profile.

          Possible values include:
          • "NOT_SHARED"
          • "SHARED_WITH_ME"
          • "SHARED_BY_ME"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags that you associated with the specified resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
route53profiles.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) for the resource that you want to list the tags for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>)

        The tags that are associated with the resource that you specified in the ListTagsForResource request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds one or more tags to a specified resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
route53profiles.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) for the resource that you want to add tags to.

    • Tags — (map<String>)

      The tags that you want to add to the specified resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes one or more tags from a specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
route53profiles.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) for the resource that you want to remove tags from.

    • TagKeys — (Array<String>)

      The tags that you want to remove to the specified resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateProfileResourceAssociation(params = {}, callback) ⇒ AWS.Request

Updates the specified Route 53 Profile resourse association.

Service Reference:

Examples:

Calling the updateProfileResourceAssociation operation

var params = {
  ProfileResourceAssociationId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE',
  ResourceProperties: 'STRING_VALUE'
};
route53profiles.updateProfileResourceAssociation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String)

      Name of the resource association.

    • ProfileResourceAssociationId — (String)

      ID of the resource association.

    • ResourceProperties — (String)

      If you are adding a DNS Firewall rule group, include also a priority. The priority indicates the processing order for the rule groups, starting with the priority assinged the lowest value.

      The allowed values for priority are between 100 and 9900.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProfileResourceAssociation — (map)

        Information about the UpdateProfileResourceAssociation request, including a status message.

        • CreationTime — (Date)

          The date and time that the Profile resource association was created, in Unix time format and Coordinated Universal Time (UTC).

        • Id — (String)

          ID of the Profile resource association.

        • ModificationTime — (Date)

          The date and time that the Profile resource association was modified, in Unix time format and Coordinated Universal Time (UTC).

        • Name — (String)

          Name of the Profile resource association.

        • OwnerId — (String)

          Amazon Web Services account ID of the Profile resource association owner.

        • ProfileId — (String)

          Profile ID of the Profile that the resources are associated with.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the resource association.

        • ResourceProperties — (String)

          If the DNS resource is a DNS Firewall rule group, this indicates the priority.

        • ResourceType — (String)

          Resource type, such as a private hosted zone, or DNS Firewall rule group.

        • Status — (String)

          Status of the Profile resource association.

          Possible values include:
          • "COMPLETE"
          • "DELETING"
          • "UPDATING"
          • "CREATING"
          • "DELETED"
          • "FAILED"
        • StatusMessage — (String)

          Additional information about the Profile resource association.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.