Class: AWS.VPCLattice

var params = {
  destinationArn: 'STRING_VALUE', /* required */
  resourceIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createAccessLogSubscription(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)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

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

    The Amazon Resource Name (ARN) of the destination. The supported destination types are CloudWatch Log groups, Kinesis Data Firehose delivery streams, and Amazon S3 buckets.

  • resourceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service network or service.

  • tags — (map<String>)

    The tags for the access log subscription.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the access log subscription.

    • destinationArn — (String)

      The Amazon Resource Name (ARN) of the log destination.

    • id — (String)

      The ID of the access log subscription.

    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the service network or service.

    • resourceId — (String)

      The ID of the service network or service.

Returns:

• (AWS.Request) —

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

var params = {
  defaultAction: { /* required */
    fixedResponse: {
      statusCode: 'NUMBER_VALUE' /* required */
    },
    forward: {
      targetGroups: [ /* required */
        {
          targetGroupIdentifier: 'STRING_VALUE', /* required */
          weight: 'NUMBER_VALUE'
        },
        /* more items */
      ]
    }
  },
  name: 'STRING_VALUE', /* required */
  protocol: HTTP | HTTPS, /* required */
  serviceIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  port: 'NUMBER_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createListener(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)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

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

    The action for the default rule. Each listener has a default rule. Each rule consists of a priority, one or more actions, and one or more conditions. The default rule is the rule that's used if no other rules match. Each rule must include exactly one of the following types of actions: forward or fixed-response, and it must be the last action to be performed.

    • fixedResponse — (map)

      Describes the rule action that returns a custom HTTP response.

      • statusCode — required — (Integer)

        The HTTP response code.

    • forward — (map)

      The forward action. Traffic that matches the rule is forwarded to the specified target groups.

      • targetGroups — required — (Array<map>)

        The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

        The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of traffic will go to that target group.

        • targetGroupIdentifier — required — (String)

          The ID or Amazon Resource Name (ARN) of the target group.

        • weight — (Integer)

          Only required if you specify multiple target groups for a forward action. The "weight" determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

  • name — (String)

    The name of the listener. A listener name must be unique within a service. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

  • port — (Integer)

    The listener port. You can specify a value from 1 to 65535. For HTTP, the default is 80. For HTTPS, the default is 443.

  • protocol — (String)

    The listener protocol HTTP or HTTPS.

    Possible values include:
    • "HTTP"
    • "HTTPS"
  • serviceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

  • tags — (map<String>)

    The tags for the listener.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the listener.

    • defaultAction — (map)

      The action for the default rule.

      • fixedResponse — (map)

        Describes the rule action that returns a custom HTTP response.

        • statusCode — required — (Integer)

          The HTTP response code.

      • forward — (map)

        The forward action. Traffic that matches the rule is forwarded to the specified target groups.

        • targetGroups — required — (Array<map>)

          The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

          The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of traffic will go to that target group.

          • targetGroupIdentifier — required — (String)

            The ID or Amazon Resource Name (ARN) of the target group.

          • weight — (Integer)

            Only required if you specify multiple target groups for a forward action. The "weight" determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

    • id — (String)

      The ID of the listener.

    • name — (String)

      The name of the listener.

    • port — (Integer)

      The port number of the listener.

    • protocol — (String)

      The protocol of the listener.

      Possible values include:
      • "HTTP"
      • "HTTPS"
    • serviceArn — (String)

      The Amazon Resource Name (ARN) of the service.

    • serviceId — (String)

      The ID of the service.

Returns:

• (AWS.Request) —

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

var params = {
  action: { /* required */
    fixedResponse: {
      statusCode: 'NUMBER_VALUE' /* required */
    },
    forward: {
      targetGroups: [ /* required */
        {
          targetGroupIdentifier: 'STRING_VALUE', /* required */
          weight: 'NUMBER_VALUE'
        },
        /* more items */
      ]
    }
  },
  listenerIdentifier: 'STRING_VALUE', /* required */
  match: { /* required */
    httpMatch: {
      headerMatches: [
        {
          match: { /* required */
            contains: 'STRING_VALUE',
            exact: 'STRING_VALUE',
            prefix: 'STRING_VALUE'
          },
          name: 'STRING_VALUE', /* required */
          caseSensitive: true || false
        },
        /* more items */
      ],
      method: 'STRING_VALUE',
      pathMatch: {
        match: { /* required */
          exact: 'STRING_VALUE',
          prefix: 'STRING_VALUE'
        },
        caseSensitive: true || false
      }
    }
  },
  name: 'STRING_VALUE', /* required */
  priority: 'NUMBER_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createRule(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: {}) —
  • action — (map)

    The action for the default rule.

    • fixedResponse — (map)

      Describes the rule action that returns a custom HTTP response.

      • statusCode — required — (Integer)

        The HTTP response code.

    • forward — (map)

      The forward action. Traffic that matches the rule is forwarded to the specified target groups.

      • targetGroups — required — (Array<map>)

        The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

        The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of traffic will go to that target group.

        • targetGroupIdentifier — required — (String)

          The ID or Amazon Resource Name (ARN) of the target group.

        • weight — (Integer)

          Only required if you specify multiple target groups for a forward action. The "weight" determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

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

    The ID or Amazon Resource Name (ARN) of the listener.

  • match — (map)

    The rule match.

    • httpMatch — (map)

      The HTTP criteria that a rule must match.

      • headerMatches — (Array<map>)

        The header matches. Matches incoming requests with rule based on request header value before applying rule action.

        • caseSensitive — (Boolean)

          Indicates whether the match is case sensitive. Defaults to false.

        • match — required — (map)

          The header match type.

          • contains — (String)

            Specifies a contains type match.

          • exact — (String)

            Specifies an exact type match.

          • prefix — (String)

            Specifies a prefix type match. Matches the value with the prefix.

        • name — required — (String)

          The name of the header.

      • method — (String)

        The HTTP method type.

      • pathMatch — (map)

        The path match.

        • caseSensitive — (Boolean)

          Indicates whether the match is case sensitive. Defaults to false.

        • match — required — (map)

          The type of path match.

          • exact — (String)

            An exact match of the path.

          • prefix — (String)

            A prefix match of the path.

  • name — (String)

    The name of the rule. The name must be unique within the listener. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

  • priority — (Integer)

    The priority assigned to the rule. Each rule for a specific listener must have a unique priority. The lower the priority number the higher the priority.

  • serviceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

  • tags — (map<String>)

    The tags for the rule.

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:

    • action — (map)

      The rule action. Each rule must include exactly one of the following types of actions: forward or fixed-response, and it must be the last action to be performed.

      • fixedResponse — (map)

        Describes the rule action that returns a custom HTTP response.

        • statusCode — required — (Integer)

          The HTTP response code.

      • forward — (map)

        The forward action. Traffic that matches the rule is forwarded to the specified target groups.

        • targetGroups — required — (Array<map>)

          The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

          The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of traffic will go to that target group.

          • targetGroupIdentifier — required — (String)

            The ID or Amazon Resource Name (ARN) of the target group.

          • weight — (Integer)

            Only required if you specify multiple target groups for a forward action. The "weight" determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

    • arn — (String)

      The Amazon Resource Name (ARN) of the rule.

    • id — (String)

      The ID of the rule.

    • match — (map)

      The rule match. The RuleMatch must be an HttpMatch. This means that the rule should be an exact match on HTTP constraints which are made up of the HTTP method, path, and header.

      • httpMatch — (map)

        The HTTP criteria that a rule must match.

        • headerMatches — (Array<map>)

          The header matches. Matches incoming requests with rule based on request header value before applying rule action.

          • caseSensitive — (Boolean)

            Indicates whether the match is case sensitive. Defaults to false.

          • match — required — (map)

            The header match type.

            • contains — (String)

              Specifies a contains type match.

            • exact — (String)

              Specifies an exact type match.

            • prefix — (String)

              Specifies a prefix type match. Matches the value with the prefix.

          • name — required — (String)

            The name of the header.

        • method — (String)

          The HTTP method type.

        • pathMatch — (map)

          The path match.

          • caseSensitive — (Boolean)

            Indicates whether the match is case sensitive. Defaults to false.

          • match — required — (map)

            The type of path match.

            • exact — (String)

              An exact match of the path.

            • prefix — (String)

              A prefix match of the path.

    • name — (String)

      The name of the rule.

    • priority — (Integer)

      The priority assigned to the rule. The lower the priority number the higher the priority.

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  authType: NONE | AWS_IAM,
  certificateArn: 'STRING_VALUE',
  clientToken: 'STRING_VALUE',
  customDomainName: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createService(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: {}) —
  • authType — (String)

    The type of IAM policy.

    • NONE: The resource does not use an IAM policy. This is the default.

    • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

    Possible values include:
    • "NONE"
    • "AWS_IAM"
  • certificateArn — (String)

    The Amazon Resource Name (ARN) of the certificate.

  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

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

    The custom domain name of the service.

  • name — (String)

    The name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

  • tags — (map<String>)

    The tags for the service.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the service.

    • authType — (String)

      The type of IAM policy.

      Possible values include:
      • "NONE"
      • "AWS_IAM"
    • certificateArn — (String)

      The Amazon Resource Name (ARN) of the certificate.

    • customDomainName — (String)

      The custom domain name of the service.

    • dnsEntry — (map)

      The public DNS name of the service.

      • domainName — (String)

        The domain name of the service.

      • hostedZoneId — (String)

        The ID of the hosted zone.

    • id — (String)

      The ID of the service.

    • name — (String)

      The name of the service.

    • status — (String)

      The status. If the status is CREATE_FAILED, you will have to delete and recreate the service.

      Possible values include:
      • "ACTIVE"
      • "CREATE_IN_PROGRESS"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  authType: NONE | AWS_IAM,
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createServiceNetwork(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: {}) —
  • authType — (String)

    The type of IAM policy.

    • NONE: The resource does not use an IAM policy. This is the default.

    • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

    Possible values include:
    • "NONE"
    • "AWS_IAM"
  • clientToken — (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

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

    The name of the service network. The name must be unique to the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

  • tags — (map<String>)

    The tags for the service network.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the service network.

    • authType — (String)

      The type of IAM policy.

      Possible values include:
      • "NONE"
      • "AWS_IAM"
    • id — (String)

      The ID of the service network.

    • name — (String)

      The name of the service network.

Returns:

• (AWS.Request) —

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

var params = {
  serviceIdentifier: 'STRING_VALUE', /* required */
  serviceNetworkIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createServiceNetworkServiceAssociation(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)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

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

    The ID or Amazon Resource Name (ARN) of the service.

  • serviceNetworkIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts.

  • tags — (map<String>)

    The tags for the association.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the association.

    • createdBy — (String)

      The account that created the association.

    • customDomainName — (String)

      The custom domain name of the service.

    • dnsEntry — (map)

      The DNS name of the service.

      • domainName — (String)

        The domain name of the service.

      • hostedZoneId — (String)

        The ID of the hosted zone.

    • id — (String)

      The ID of the association.

    • status — (String)

      The operation's status.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "ACTIVE"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  serviceNetworkIdentifier: 'STRING_VALUE', /* required */
  vpcIdentifier: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  securityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createServiceNetworkVpcAssociation(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)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

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

    The IDs of the security groups. Security groups aren't added by default. You can add a security group to apply network level controls to control which resources in a VPC are allowed to access the service network and its services. For more information, see Control traffic to resources using security groups in the Amazon VPC User Guide.

  • serviceNetworkIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service network. You must use the ARN when the resources specified in the operation are in different accounts.

  • tags — (map<String>)

    The tags for the association.

  • vpcIdentifier — (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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the association.

    • createdBy — (String)

      The account that created the association.

    • id — (String)

      The ID of the association.

    • securityGroupIds — (Array<String>)

      The IDs of the security groups.

    • status — (String)

      The operation's status.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "ACTIVE"
      • "UPDATE_IN_PROGRESS"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"
      • "UPDATE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  type: IP | LAMBDA | INSTANCE | ALB, /* required */
  clientToken: 'STRING_VALUE',
  config: {
    healthCheck: {
      enabled: true || false,
      healthCheckIntervalSeconds: 'NUMBER_VALUE',
      healthCheckTimeoutSeconds: 'NUMBER_VALUE',
      healthyThresholdCount: 'NUMBER_VALUE',
      matcher: {
        httpCode: 'STRING_VALUE'
      },
      path: 'STRING_VALUE',
      port: 'NUMBER_VALUE',
      protocol: HTTP | HTTPS,
      protocolVersion: HTTP1 | HTTP2,
      unhealthyThresholdCount: 'NUMBER_VALUE'
    },
    ipAddressType: IPV4 | IPV6,
    lambdaEventStructureVersion: V1 | V2,
    port: 'NUMBER_VALUE',
    protocol: HTTP | HTTPS,
    protocolVersion: HTTP1 | HTTP2 | GRPC,
    vpcIdentifier: 'STRING_VALUE'
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.createTargetGroup(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)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

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

    The target group configuration. If type is set to LAMBDA, this parameter doesn't apply.

    • healthCheck — (map)

      The health check configuration.

      • enabled — (Boolean)

        Indicates whether health checking is enabled.

      • healthCheckIntervalSeconds — (Integer)

        The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

      • healthCheckTimeoutSeconds — (Integer)

        The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

      • healthyThresholdCount — (Integer)

        The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

      • matcher — (map)

        The codes to use when checking for a successful response from a target. These are called Success codes in the console.

        • httpCode — (String)

          The HTTP code to use when checking for a successful response from a target.

      • path — (String)

        The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

      • port — (Integer)

        The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

      • protocol — (String)

        The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

        Possible values include:
        • "HTTP"
        • "HTTPS"
      • protocolVersion — (String)

        The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

        Possible values include:
        • "HTTP1"
        • "HTTP2"
      • unhealthyThresholdCount — (Integer)

        The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

    • ipAddressType — (String)

      The type of IP address used for the target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

      Possible values include:
      • "IPV4"
      • "IPV6"
    • lambdaEventStructureVersion — (String)

      Lambda event structure version

      Possible values include:
      • "V1"
      • "V2"
    • port — (Integer)

      The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443

    • protocol — (String)

      The protocol to use for routing traffic to the targets. Default is the protocol of a target group.

      Possible values include:
      • "HTTP"
      • "HTTPS"
    • protocolVersion — (String)

      The protocol version. Default value is HTTP1.

      Possible values include:
      • "HTTP1"
      • "HTTP2"
      • "GRPC"
    • vpcIdentifier — (String)

      The ID of the VPC.

  • name — (String)

    The name of the target group. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

  • tags — (map<String>)

    The tags for the target group.

  • type — (String)

    The type of target group.

    Possible values include:
    • "IP"
    • "LAMBDA"
    • "INSTANCE"
    • "ALB"

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the target group.

    • config — (map)

      The target group configuration. If type is set to LAMBDA, this parameter doesn't apply.

      • healthCheck — (map)

        The health check configuration.

        • enabled — (Boolean)

          Indicates whether health checking is enabled.

        • healthCheckIntervalSeconds — (Integer)

          The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

        • healthCheckTimeoutSeconds — (Integer)

          The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

        • healthyThresholdCount — (Integer)

          The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

        • matcher — (map)

          The codes to use when checking for a successful response from a target. These are called Success codes in the console.

          • httpCode — (String)

            The HTTP code to use when checking for a successful response from a target.

        • path — (String)

          The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

        • port — (Integer)

          The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

        • protocol — (String)

          The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

          Possible values include:
          • "HTTP"
          • "HTTPS"
        • protocolVersion — (String)

          The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

          Possible values include:
          • "HTTP1"
          • "HTTP2"
        • unhealthyThresholdCount — (Integer)

          The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

      • ipAddressType — (String)

        The type of IP address used for the target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

        Possible values include:
        • "IPV4"
        • "IPV6"
      • lambdaEventStructureVersion — (String)

        Lambda event structure version

        Possible values include:
        • "V1"
        • "V2"
      • port — (Integer)

        The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443

      • protocol — (String)

        The protocol to use for routing traffic to the targets. Default is the protocol of a target group.

        Possible values include:
        • "HTTP"
        • "HTTPS"
      • protocolVersion — (String)

        The protocol version. Default value is HTTP1.

        Possible values include:
        • "HTTP1"
        • "HTTP2"
        • "GRPC"
      • vpcIdentifier — (String)

        The ID of the VPC.

    • id — (String)

      The ID of the target group.

    • name — (String)

      The name of the target group.

    • status — (String)

      The operation's status. You can retry the operation if the status is CREATE_FAILED. However, if you retry it while the status is CREATE_IN_PROGRESS, there is no change in the status.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "ACTIVE"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"
    • type — (String)

      The type of target group.

      Possible values include:
      • "IP"
      • "LAMBDA"
      • "INSTANCE"
      • "ALB"

Returns:

• (AWS.Request) —

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

var params = {
  accessLogSubscriptionIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteAccessLogSubscription(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: {}) —
  • accessLogSubscriptionIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the access log subscription.

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.

var params = {
  resourceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteAuthPolicy(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: {}) —
  • resourceIdentifier — (String)

    The ID or 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.

Returns:

• (AWS.Request) —

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

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteListener(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: {}) —
  • listenerIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the listener.

  • serviceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

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.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
vpclattice.deleteResourcePolicy(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) 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.

Returns:

• (AWS.Request) —

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

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  ruleIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteRule(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: {}) —
  • listenerIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the listener.

  • ruleIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the rule.

  • serviceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

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.

var params = {
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteService(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: {}) —
  • serviceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the service.

    • id — (String)

      The ID of the service.

    • name — (String)

      The name of the service.

    • status — (String)

      The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, the status doesn't change.

      Possible values include:
      • "ACTIVE"
      • "CREATE_IN_PROGRESS"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  serviceNetworkIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteServiceNetwork(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: {}) —
  • serviceNetworkIdentifier — (String)

    The Amazon Resource Name (ARN) or ID of the service network.

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.

var params = {
  serviceNetworkServiceAssociationIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteServiceNetworkServiceAssociation(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: {}) —
  • serviceNetworkServiceAssociationIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the association.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the association.

    • id — (String)

      The ID of the association.

    • status — (String)

      The operation's status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it when the status is DELETE_IN_PROGRESS, there is no change in the status.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "ACTIVE"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  serviceNetworkVpcAssociationIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteServiceNetworkVpcAssociation(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: {}) —
  • serviceNetworkVpcAssociationIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the association.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the association.

    • id — (String)

      The ID of the association.

    • status — (String)

      The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it when the status is DELETE_IN_PROGRESS, there is no change in the status.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "ACTIVE"
      • "UPDATE_IN_PROGRESS"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"
      • "UPDATE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  targetGroupIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.deleteTargetGroup(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: {}) —
  • targetGroupIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the target group.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the target group.

    • id — (String)

      The ID of the target group.

    • status — (String)

      The status. You can retry the operation if the status is DELETE_FAILED. However, if you retry it while the status is DELETE_IN_PROGRESS, the status doesn't change.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "ACTIVE"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  targetGroupIdentifier: 'STRING_VALUE', /* required */
  targets: [ /* required */
    {
      id: 'STRING_VALUE', /* required */
      port: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
vpclattice.deregisterTargets(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: {}) —
  • targetGroupIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the target group.

  • targets — (Array<map>)

    The targets to deregister.

    • id — required — (String)

      The ID of the target. If the target type of the target group is INSTANCE, this is an instance ID. If the target type is IP , this is an IP address. If the target type is LAMBDA, this is the ARN of the Lambda function. If the target type is ALB, this is the ARN of the Application Load Balancer.

    • port — (Integer)

      The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.

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:

    • successful — (Array<map>)

      The targets that were successfully deregistered.

      • id — required — (String)

        The ID of the target. If the target type of the target group is INSTANCE, this is an instance ID. If the target type is IP , this is an IP address. If the target type is LAMBDA, this is the ARN of the Lambda function. If the target type is ALB, this is the ARN of the Application Load Balancer.

      • port — (Integer)

        The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.

    • unsuccessful — (Array<map>)

      The targets that the operation couldn't deregister.

      • failureCode — (String)

        The failure code.

      • failureMessage — (String)

        The failure message.

      • id — (String)

        The ID of the target. If the target type of the target group is INSTANCE, this is an instance ID. If the target type is IP , this is an IP address. If the target type is LAMBDA, this is the ARN of the Lambda function. If the target type is ALB, this is the ARN of the Application Load Balancer.

      • port — (Integer)

        The port on which the target is listening. This parameter doesn't apply if the target is a Lambda function.

Returns:

• (AWS.Request) —

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

var params = {
  accessLogSubscriptionIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getAccessLogSubscription(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: {}) —
  • accessLogSubscriptionIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the access log subscription.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the access log subscription.

    • createdAt — (Date)

      The date and time that the access log subscription was created, specified in ISO-8601 format.

    • destinationArn — (String)

      The Amazon Resource Name (ARN) of the access log destination.

    • id — (String)

      The ID of the access log subscription.

    • lastUpdatedAt — (Date)

      The date and time that the access log subscription was last updated, specified in ISO-8601 format.

    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the service network or service.

    • resourceId — (String)

      The ID of the service network or service.

Returns:

• (AWS.Request) —

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

var params = {
  resourceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getAuthPolicy(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: {}) —
  • resourceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service network or service.

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:

    • createdAt — (Date)

      The date and time that the auth policy was created, specified in ISO-8601 format.

    • lastUpdatedAt — (Date)

      The date and time that the auth policy was last updated, specified in ISO-8601 format.

    • policy — (String)

      The auth policy.

    • state — (String)

      The state of the auth policy. The auth policy is only active when the auth type is set to Amazon Web Services_IAM. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the auth type is NONE, then any auth policy you provide will remain inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.

      Possible values include:
      • "Active"
      • "Inactive"

Returns:

• (AWS.Request) —

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

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getListener(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: {}) —
  • listenerIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the listener.

  • serviceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the listener.

    • createdAt — (Date)

      The date and time that the listener was created, specified in ISO-8601 format.

    • defaultAction — (map)

      The actions for the default listener rule.

      • fixedResponse — (map)

        Describes the rule action that returns a custom HTTP response.

        • statusCode — required — (Integer)

          The HTTP response code.

      • forward — (map)

        The forward action. Traffic that matches the rule is forwarded to the specified target groups.

        • targetGroups — required — (Array<map>)

          The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

          The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of traffic will go to that target group.

          • targetGroupIdentifier — required — (String)

            The ID or Amazon Resource Name (ARN) of the target group.

          • weight — (Integer)

            Only required if you specify multiple target groups for a forward action. The "weight" determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

    • id — (String)

      The ID of the listener.

    • lastUpdatedAt — (Date)

      The date and time that the listener was last updated, specified in ISO-8601 format.

    • name — (String)

      The name of the listener.

    • port — (Integer)

      The listener port.

    • protocol — (String)

      The listener protocol.

      Possible values include:
      • "HTTP"
      • "HTTPS"
    • serviceArn — (String)

      The Amazon Resource Name (ARN) of the service.

    • serviceId — (String)

      The ID of the service.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
vpclattice.getResourcePolicy(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)

    An IAM policy.

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:

    • policy — (String)

      The Amazon Resource Name (ARN) of the service network or service.

Returns:

• (AWS.Request) —

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

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  ruleIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getRule(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: {}) —
  • listenerIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the listener.

  • ruleIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the listener rule.

  • serviceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

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:

    • action — (map)

      The action for the default rule.

      • fixedResponse — (map)

        Describes the rule action that returns a custom HTTP response.

        • statusCode — required — (Integer)

          The HTTP response code.

      • forward — (map)

        The forward action. Traffic that matches the rule is forwarded to the specified target groups.

        • targetGroups — required — (Array<map>)

          The target groups. Traffic matching the rule is forwarded to the specified target groups. With forward actions, you can assign a weight that controls the prioritization and selection of each target group. This means that requests are distributed to individual target groups based on their weights. For example, if two target groups have the same weight, each target group receives half of the traffic.

          The default value is 1. This means that if only one target group is provided, there is no need to set the weight; 100% of traffic will go to that target group.

          • targetGroupIdentifier — required — (String)

            The ID or Amazon Resource Name (ARN) of the target group.

          • weight — (Integer)

            Only required if you specify multiple target groups for a forward action. The "weight" determines how requests are distributed to the target group. For example, if you specify two target groups, each with a weight of 10, each target group receives half the requests. If you specify two target groups, one with a weight of 10 and the other with a weight of 20, the target group with a weight of 20 receives twice as many requests as the other target group. If there's only one target group specified, then the default value is 100.

    • arn — (String)

      The Amazon Resource Name (ARN) of the listener.

    • createdAt — (Date)

      The date and time that the listener rule was created, specified in ISO-8601 format.

    • id — (String)

      The ID of the listener.

    • isDefault — (Boolean)

      Indicates whether this is the default rule.

    • lastUpdatedAt — (Date)

      The date and time that the listener rule was last updated, specified in ISO-8601 format.

    • match — (map)

      The rule match.

      • httpMatch — (map)

        The HTTP criteria that a rule must match.

        • headerMatches — (Array<map>)

          The header matches. Matches incoming requests with rule based on request header value before applying rule action.

          • caseSensitive — (Boolean)

            Indicates whether the match is case sensitive. Defaults to false.

          • match — required — (map)

            The header match type.

            • contains — (String)

              Specifies a contains type match.

            • exact — (String)

              Specifies an exact type match.

            • prefix — (String)

              Specifies a prefix type match. Matches the value with the prefix.

          • name — required — (String)

            The name of the header.

        • method — (String)

          The HTTP method type.

        • pathMatch — (map)

          The path match.

          • caseSensitive — (Boolean)

            Indicates whether the match is case sensitive. Defaults to false.

          • match — required — (map)

            The type of path match.

            • exact — (String)

              An exact match of the path.

            • prefix — (String)

              A prefix match of the path.

    • name — (String)

      The name of the listener.

    • priority — (Integer)

      The priority level for the specified rule.

Returns:

• (AWS.Request) —

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

var params = {
  serviceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getService(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: {}) —
  • serviceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the service.

    • authType — (String)

      The type of IAM policy.

      Possible values include:
      • "NONE"
      • "AWS_IAM"
    • certificateArn — (String)

      The Amazon Resource Name (ARN) of the certificate.

    • createdAt — (Date)

      The date and time that the service was created, specified in ISO-8601 format.

    • customDomainName — (String)

      The custom domain name of the service.

    • dnsEntry — (map)

      The DNS name of the service.

      • domainName — (String)

        The domain name of the service.

      • hostedZoneId — (String)

        The ID of the hosted zone.

    • failureCode — (String)

      The failure code.

    • failureMessage — (String)

      The failure message.

    • id — (String)

      The ID of the service.

    • lastUpdatedAt — (Date)

      The date and time that the service was last updated, specified in ISO-8601 format.

    • name — (String)

      The name of the service.

    • status — (String)

      The status of the service.

      Possible values include:
      • "ACTIVE"
      • "CREATE_IN_PROGRESS"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  serviceNetworkIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getServiceNetwork(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: {}) —
  • serviceNetworkIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service network.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the service network.

    • authType — (String)

      The type of IAM policy.

      Possible values include:
      • "NONE"
      • "AWS_IAM"
    • createdAt — (Date)

      The date and time that the service network was created, specified in ISO-8601 format.

    • id — (String)

      The ID of the service network.

    • lastUpdatedAt — (Date)

      The date and time of the last update, specified in ISO-8601 format.

    • name — (String)

      The name of the service network.

    • numberOfAssociatedServices — (Integer)

      The number of services associated with the service network.

    • numberOfAssociatedVPCs — (Integer)

      The number of VPCs associated with the service network.

Returns:

• (AWS.Request) —

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

var params = {
  serviceNetworkServiceAssociationIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getServiceNetworkServiceAssociation(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: {}) —
  • serviceNetworkServiceAssociationIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the association.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the association.

    • createdAt — (Date)

      The date and time that the association was created, specified in ISO-8601 format.

    • createdBy — (String)

      The account that created the association.

    • customDomainName — (String)

      The custom domain name of the service.

    • dnsEntry — (map)

      The DNS name of the service.

      • domainName — (String)

        The domain name of the service.

      • hostedZoneId — (String)

        The ID of the hosted zone.

    • failureCode — (String)

      The failure code.

    • failureMessage — (String)

      The failure message.

    • id — (String)

      The ID of the service network and service association.

    • serviceArn — (String)

      The Amazon Resource Name (ARN) of the service.

    • serviceId — (String)

      The ID of the service.

    • serviceName — (String)

      The name of the service.

    • serviceNetworkArn — (String)

      The Amazon Resource Name (ARN) of the service network.

    • serviceNetworkId — (String)

      The ID of the service network.

    • serviceNetworkName — (String)

      The name of the service network.

    • status — (String)

      The status of the association.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "ACTIVE"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"

Returns:

• (AWS.Request) —

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

var params = {
  serviceNetworkVpcAssociationIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getServiceNetworkVpcAssociation(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: {}) —
  • serviceNetworkVpcAssociationIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the association.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the association.

    • createdAt — (Date)

      The date and time that the association was created, specified in ISO-8601 format.

    • createdBy — (String)

      The account that created the association.

    • failureCode — (String)

      The failure code.

    • failureMessage — (String)

      The failure message.

    • id — (String)

      The ID of the specified association between the service network and the VPC.

    • lastUpdatedAt — (Date)

      The date and time that the association was last updated, specified in ISO-8601 format.

    • securityGroupIds — (Array<String>)

      The IDs of the security groups.

    • serviceNetworkArn — (String)

      The Amazon Resource Name (ARN) of the service network.

    • serviceNetworkId — (String)

      The ID of the service network.

    • serviceNetworkName — (String)

      The name of the service network.

    • status — (String)

      The status of the association.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "ACTIVE"
      • "UPDATE_IN_PROGRESS"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"
      • "UPDATE_FAILED"
    • vpcId — (String)

      The ID of the VPC.

Returns:

• (AWS.Request) —

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

var params = {
  targetGroupIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.getTargetGroup(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: {}) —
  • targetGroupIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the target group.

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:

    • arn — (String)

      The Amazon Resource Name (ARN) of the target group.

    • config — (map)

      The target group configuration.

      • healthCheck — (map)

        The health check configuration.

        • enabled — (Boolean)

          Indicates whether health checking is enabled.

        • healthCheckIntervalSeconds — (Integer)

          The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

        • healthCheckTimeoutSeconds — (Integer)

          The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

        • healthyThresholdCount — (Integer)

          The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

        • matcher — (map)

          The codes to use when checking for a successful response from a target. These are called Success codes in the console.

          • httpCode — (String)

            The HTTP code to use when checking for a successful response from a target.

        • path — (String)

          The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

        • port — (Integer)

          The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

        • protocol — (String)

          The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

          Possible values include:
          • "HTTP"
          • "HTTPS"
        • protocolVersion — (String)

          The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

          Possible values include:
          • "HTTP1"
          • "HTTP2"
        • unhealthyThresholdCount — (Integer)

          The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

      • ipAddressType — (String)

        The type of IP address used for the target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

        Possible values include:
        • "IPV4"
        • "IPV6"
      • lambdaEventStructureVersion — (String)

        Lambda event structure version

        Possible values include:
        • "V1"
        • "V2"
      • port — (Integer)

        The port on which the targets are listening. For HTTP, the default is 80. For HTTPS, the default is 443

      • protocol — (String)

        The protocol to use for routing traffic to the targets. Default is the protocol of a target group.

        Possible values include:
        • "HTTP"
        • "HTTPS"
      • protocolVersion — (String)

        The protocol version. Default value is HTTP1.

        Possible values include:
        • "HTTP1"
        • "HTTP2"
        • "GRPC"
      • vpcIdentifier — (String)

        The ID of the VPC.

    • createdAt — (Date)

      The date and time that the target group was created, specified in ISO-8601 format.

    • failureCode — (String)

      The failure code.

    • failureMessage — (String)

      The failure message.

    • id — (String)

      The ID of the target group.

    • lastUpdatedAt — (Date)

      The date and time that the target group was last updated, specified in ISO-8601 format.

    • name — (String)

      The name of the target group.

    • serviceArns — (Array<String>)

      The Amazon Resource Names (ARNs) of the service.

    • status — (String)

      The status.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "ACTIVE"
      • "DELETE_IN_PROGRESS"
      • "CREATE_FAILED"
      • "DELETE_FAILED"
    • type — (String)

      The target group type.

      Possible values include:
      • "IP"
      • "LAMBDA"
      • "INSTANCE"
      • "ALB"

Returns:

• (AWS.Request) —

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

var params = {
  resourceIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
vpclattice.listAccessLogSubscriptions(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 results to return.

  • nextToken — (String)

    A pagination token for the next page of results.

  • resourceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service network or service.

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:

    • items — (Array<map>)

      The access log subscriptions.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the access log subscription

      • createdAt — required — (Date)

        The date and time that the access log subscription was created, specified in ISO-8601 format.

      • destinationArn — required — (String)

        The Amazon Resource Name (ARN) of the destination.

      • id — required — (String)

        The ID of the access log subscription.

      • lastUpdatedAt — required — (Date)

        The date and time that the access log subscription was last updated, specified in ISO-8601 format.

      • resourceArn — required — (String)

        The Amazon Resource Name (ARN) of the service or service network.

      • resourceId — required — (String)

        The ID of the service or service network.

    • nextToken — (String)

      A pagination token for the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  serviceIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
vpclattice.listListeners(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 results to return.

  • nextToken — (String)

    A pagination token for the next page of results.

  • serviceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

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:

    • items — (Array<map>)

      Information about the listeners.

      • arn — (String)

        The Amazon Resource Name (ARN) of the listener.

      • createdAt — (Date)

        The date and time that the listener was created, specified in ISO-8601 format.

      • id — (String)

        The ID of the listener.

      • lastUpdatedAt — (Date)

        The date and time that the listener was last updated, specified in ISO-8601 format.

      • name — (String)

        The name of the listener.

      • port — (Integer)

        The listener port.

      • protocol — (String)

        The listener protocol.

        Possible values include:
        • "HTTP"
        • "HTTPS"
    • nextToken — (String)

      If there are additional results, a pagination token for the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  listenerIdentifier: 'STRING_VALUE', /* required */
  serviceIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
vpclattice.listRules(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: {}) —
  • listenerIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the listener.

  • maxResults — (Integer)

    The maximum number of results to return.

  • nextToken — (String)

    A pagination token for the next page of results.

  • serviceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

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:

    • items — (Array<map>)

      Information about the rules.

      • arn — (String)

        The Amazon Resource Name (ARN) of the rule.

      • createdAt — (Date)

        The date and time that the listener rule was created, specified in ISO-8601 format.

      • id — (String)

        The ID of the rule.

      • isDefault — (Boolean)

        Indicates whether this is the default rule. Listener rules are created when you create a listener. Each listener has a default rule for checking connection requests.

      • lastUpdatedAt — (Date)

        The date and time that the listener rule was last updated, specified in ISO-8601 format.

      • name — (String)

        The name of the rule.

      • priority — (Integer)

        The priority of the rule.

    • nextToken — (String)

      If there are additional results, a pagination token for the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
vpclattice.listServiceNetworks(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 results to return.

  • nextToken — (String)

    A pagination token for the next page of results.

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:

    • items — (Array<map>)

      Information about the service networks.

      • arn — (String)

        The Amazon Resource Name (ARN) of the service network.

      • createdAt — (Date)

        The date and time that the service network was created, specified in ISO-8601 format.

      • id — (String)

        The ID of the service network.

      • lastUpdatedAt — (Date)

        The date and time that the service network was last updated, specified in ISO-8601 format.

      • name — (String)

        The name of the service network.

      • numberOfAssociatedServices — (Integer)

        The number of services associated with the service network.

      • numberOfAssociatedVPCs — (Integer)

        The number of VPCs associated with the service network.

    • nextToken — (String)

      If there are additional results, a pagination token for the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  serviceIdentifier: 'STRING_VALUE',
  serviceNetworkIdentifier: 'STRING_VALUE'
};
vpclattice.listServiceNetworkServiceAssociations(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 results to return.

  • nextToken — (String)

    A pagination token for the next page of results.

  • serviceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

  • serviceNetworkIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service network.

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:

    • items — (Array<map>)

      Information about the associations.

      • arn — (String)

        The Amazon Resource Name (ARN) of the association.

      • createdAt — (Date)

        The date and time that the association was created, specified in ISO-8601 format.

      • createdBy — (String)

        The account that created the association.

      • customDomainName — (String)

        The custom domain name of the service.

      • dnsEntry — (map)

        DNS information about the service.

        • domainName — (String)

          The domain name of the service.

        • hostedZoneId — (String)

          The ID of the hosted zone.

      • id — (String)

        The ID of the association.

      • serviceArn — (String)

        The Amazon Resource Name (ARN) of the service.

      • serviceId — (String)

        The ID of the service.

      • serviceName — (String)

        The name of the service.

      • serviceNetworkArn — (String)

        The Amazon Resource Name (ARN) of the service network.

      • serviceNetworkId — (String)

        The ID of the service network.

      • serviceNetworkName — (String)

        The name of the service network.

      • status — (String)

        The status. If the deletion fails, try to delete again.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
    • nextToken — (String)

      If there are additional results, a pagination token for the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  serviceNetworkIdentifier: 'STRING_VALUE',
  vpcIdentifier: 'STRING_VALUE'
};
vpclattice.listServiceNetworkVpcAssociations(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 results to return.

  • nextToken — (String)

    A pagination token for the next page of results.

  • serviceNetworkIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service network.

  • vpcIdentifier — (String)

    The ID or Amazon Resource Name (ARN) 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:

    • items — (Array<map>)

      Information about the associations.

      • arn — (String)

        The Amazon Resource Name (ARN) of the association.

      • createdAt — (Date)

        The date and time that the association was created, specified in ISO-8601 format.

      • createdBy — (String)

        The account that created the association.

      • id — (String)

        The ID of the association.

      • lastUpdatedAt — (Date)

        The date and time that the association was last updated, specified in ISO-8601 format.

      • serviceNetworkArn — (String)

        The Amazon Resource Name (ARN) of the service network.

      • serviceNetworkId — (String)

        The ID of the service network.

      • serviceNetworkName — (String)

        The name of the service network.

      • status — (String)

        The status.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "UPDATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
        • "UPDATE_FAILED"
      • vpcId — (String)

        The ID of the VPC.

    • nextToken — (String)

      If there are additional results, a pagination token for the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
vpclattice.listServices(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 results to return.

  • nextToken — (String)

    A pagination token for the next page of results.

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:

    • items — (Array<map>)

      The services.

      • arn — (String)

        The Amazon Resource Name (ARN) of the service.

      • createdAt — (Date)

        The date and time that the service was created, specified in ISO-8601 format.

      • customDomainName — (String)

        The custom domain name of the service.

      • dnsEntry — (map)

        DNS information about the service.

        • domainName — (String)

          The domain name of the service.

        • hostedZoneId — (String)

          The ID of the hosted zone.

      • id — (String)

        The ID of the service.

      • lastUpdatedAt — (Date)

        The date and time that the service was last updated. The format is ISO-8601.

      • name — (String)

        The name of the service.

      • status — (String)

        The status.

        Possible values include:
        • "ACTIVE"
        • "CREATE_IN_PROGRESS"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
    • nextToken — (String)

      If there are additional results, a pagination token for the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
vpclattice.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) 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:

    • tags — (map<String>)

      The tags.

Returns:

• (AWS.Request) —

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

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  targetGroupType: IP | LAMBDA | INSTANCE | ALB,
  vpcIdentifier: 'STRING_VALUE'
};
vpclattice.listTargetGroups(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 results to return.

  • nextToken — (String)

    A pagination token for the next page of results.

  • targetGroupType — (String)

    The target group type.

    Possible values include:
    • "IP"
    • "LAMBDA"
    • "INSTANCE"
    • "ALB"
  • vpcIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service.

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:

    • items — (Array<map>)

      Information about the target groups.

      • arn — (String)

        The ARN (Amazon Resource Name) of the target group.

      • createdAt — (Date)

        The date and time that the target group was created, specified in ISO-8601 format.

      • id — (String)

        The ID of the target group.

      • ipAddressType — (String)

        The type of IP address used for the target group. The possible values are ipv4 and ipv6. This is an optional parameter. If not specified, the IP address type defaults to ipv4.

        Possible values include:
        • "IPV4"
        • "IPV6"
      • lambdaEventStructureVersion — (String)

        Lambda event structure version

        Possible values include:
        • "V1"
        • "V2"
      • lastUpdatedAt — (Date)

        The date and time that the target group was last updated, specified in ISO-8601 format.

      • name — (String)

        The name of the target group.

      • port — (Integer)

        The port of the target group.

      • protocol — (String)

        The protocol of the target group.

        Possible values include:
        • "HTTP"
        • "HTTPS"
      • serviceArns — (Array<String>)

        The list of Amazon Resource Names (ARNs) of the service.

      • status — (String)

        The status.

        Possible values include:
        • "CREATE_IN_PROGRESS"
        • "ACTIVE"
        • "DELETE_IN_PROGRESS"
        • "CREATE_FAILED"
        • "DELETE_FAILED"
      • type — (String)

        The target group type.

        Possible values include:
        • "IP"
        • "LAMBDA"
        • "INSTANCE"
        • "ALB"
      • vpcIdentifier — (String)

        The ID of the VPC of the target group.

    • nextToken — (String)

      If there are additional results, a pagination token for the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  targetGroupIdentifier: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  targets: [
    {
      id: 'STRING_VALUE', /* required */
      port: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
vpclattice.listTargets(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 results to return.

  • nextToken — (String)

    A pagination token for the next page of results.

  • targetGroupIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the target group.

  • targets — (Array<map>)

    The targets to list.

    • id — required — (String)

      The ID of the target. If the target type of the target group is INSTANCE, this is an instance ID. If the target type is IP , this is an IP address. If the target type is LAMBDA, this is the ARN of the Lambda function. If the target type is ALB, this is the ARN of the Application Load Balancer.

    • port — (Integer)

      The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.

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:

    • items — (Array<map>)

      Information about the targets.

      • id — (String)

        The ID of the target. If the target type of the target group is INSTANCE, this is an instance ID. If the target type is IP , this is an IP address. If the target type is LAMBDA, this is the ARN of the Lambda function. If the target type is ALB, this is the ARN of the Application Load Balancer.

      • port — (Integer)

        The port on which the target is listening.

      • reasonCode — (String)

        The code for why the target status is what it is.

      • status — (String)

        The status of the target.

        • Draining: The target is being deregistered. No new connections will be sent to this target while current connections are being drained. Default draining time is 5 minutes.

        • Unavailable: Health checks are unavailable for the target group.

        • Healthy: The target is healthy.

        • Unhealthy: The target is unhealthy.

        • Initial: Initial health checks on the target are being performed.

        • Unused: Target group is not used in a service.

        Possible values include:
        • "DRAINING"
        • "UNAVAILABLE"
        • "HEALTHY"
        • "UNHEALTHY"
        • "INITIAL"
        • "UNUSED"
    • nextToken — (String)

      If there are additional results, a pagination token for the next page of results.

Returns:

• (AWS.Request) —

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

var params = {
  policy: 'STRING_VALUE', /* required */
  resourceIdentifier: 'STRING_VALUE' /* required */
};
vpclattice.putAuthPolicy(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: {}) —
  • policy — (String)

    The auth policy.

  • resourceIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.

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:

    • policy — (String)

      The auth policy.

    • state — (String)

      The state of the auth policy. The auth policy is only active when the auth type is set to Amazon Web Services_IAM. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the Auth type is NONE, then, any auth policy you provide will remain inactive. For more information, see Create a service network in the Amazon VPC Lattice User Guide.

      Possible values include:
      • "Active"
      • "Inactive"

Returns:

• (AWS.Request) —

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

var params = {
  policy: 'STRING_VALUE', /* required */
  resourceArn: 'STRING_VALUE' /* required */
};
vpclattice.putResourcePolicy(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: {}) —
  • policy — (String)

    An IAM policy.

  • resourceArn — (String)

    The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.

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.

var params = {
  targetGroupIdentifier: 'STRING_VALUE', /* required */
  targets: [ /* required */
    {
      id: 'STRING_VALUE', /* required */
      port: 'NUMBER_VALUE'
    },
    /* more items */
  ]
};
vpclattice.registerTargets(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: {}) —
  • targetGroupIdentifier — (String)

    The ID or Amazon Resource Name (ARN) of the target group.

  • targets — (Array<map>)

    The targets.

    • id — required — (String)

      The ID of the target. If the target type of the target group is INSTANCE, this is an instance ID. If the target type is IP , this is an IP address. If the target type is LAMBDA, this is the ARN of the Lambda function. If the target type is ALB, this is the ARN of the Application Load Balancer.

    • port — (Integer)

      The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.

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:

    • successful — (Array<map>)

      The targets that were successfully registered.

      • id — required — (String)

        The ID of the target. If the target type of the target group is INSTANCE, this is an instance ID. If the target type is IP , this is an IP address. If the target type is LAMBDA, this is the ARN of the Lambda function. If the target type is ALB, this is the ARN of the Application Load Balancer.

      • port — (Integer)

        The port on which the target is listening. For HTTP, the default is 80. For HTTPS, the default is 443.

    • unsuccessful — (Array<map>)

      The targets that were not registered.

      • failureCode — (String)

        The failure code.

      • failureMessage — (String)

        The failure message.

      • id — (String)

        The ID of the target. If the target type of the target group is INSTANCE, this is an instance ID. If the target type is IP , this is an IP address. If the target type is LAMBDA, this is the ARN of the Lambda function. If the target type is ALB, this is the ARN of the Application Load Balancer.

      • port — (Integer)

        The port on which the target is listening. This parameter doesn't apply if the target is a Lambda function.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
vpclattice.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) of the resource.

  • tags — (map<String>)

    The tags for 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.

Returns:

• (AWS.Request) —

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

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
vpclattice.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) of the resource.

  • tagKeys — (Array<String>)

    The tag keys of the tags to remove.

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.