You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.RolesAnywhere

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

Overview

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

Service Description

AWS Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications running outside of AWS to obtain Temporary AWS credentials. Your workloads can use the same IAM policies and roles that you have configured with native AWS applications to access AWS resources. Using IAM Roles Anywhere will eliminate the need to manage long term credentials for workloads running outside of AWS.

To use IAM Roles Anywhere customer workloads will need to use X.509 certificates issued by their Certificate Authority (CA) . The Certificate Authority (CA) needs to be registered with IAM Roles Anywhere as a trust anchor to establish trust between customer PKI and IAM Roles Anywhere. Customers who do not manage their own PKI system can use AWS Certificate Manager Private Certificate Authority (ACM PCA) to create a Certificate Authority and use that to establish trust with IAM Roles Anywhere

This guide describes the IAM rolesanywhere operations that you can call programmatically. For general information about IAM Roles Anywhere see https://docs.aws.amazon.com/

Sending a Request Using RolesAnywhere

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

Locking the API Version

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

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

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

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

var rolesanywhere = new AWS.RolesAnywhere();

Version:

  • 2018-05-10

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a RolesAnywhere object

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

Options Hash (options):

  • params (map) —

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

  • endpoint (String|AWS.Endpoint) —

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

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

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

  • credentialProvider (AWS.CredentialProviderChain) —

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

  • region (String) —

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

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

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

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

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

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

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

  • convertResponseTypes (Boolean) —

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

  • correctClockSkew (Boolean) —

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

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

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

  • s3DisableBodySigning (Boolean) —

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

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

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

  • s3UseArnRegion (Boolean) —

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

  • retryDelayOptions (map) —

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

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

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

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

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

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

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

  • logger (#write, #log) —

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

  • systemClockOffset (Number) —

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

  • signatureVersion (String) —

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

  • signatureCache (Boolean) —

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

  • dynamoDbCrc32 (Boolean) —

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

  • useAccelerateEndpoint (Boolean) —

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

  • clientSideMonitoring (Boolean) —

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

  • endpointDiscoveryEnabled (Boolean|undefined) —

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

  • endpointCacheSize (Number) —

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

  • hostPrefixEnabled (Boolean) —

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

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

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

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates a profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can intersect permissions with IAM managed policies.

Required permissions: rolesanywhere:CreateProfile.

Service Reference:

Examples:

Calling the createProfile operation

var params = {
  name: 'STRING_VALUE', /* required */
  roleArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  durationSeconds: 'NUMBER_VALUE',
  enabled: true || false,
  managedPolicyArns: [
    'STRING_VALUE',
    /* more items */
  ],
  requireInstanceProperties: true || false,
  sessionPolicy: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
rolesanywhere.createProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The number of seconds the vended session credentials are valid for.

    • enabled — (Boolean)

      Specifies whether the profile is enabled.

    • managedPolicyArns — (Array<String>)

      A list of managed policy ARNs that apply to the vended session credentials.

    • name — (String)

      The name of the profile.

    • requireInstanceProperties — (Boolean)

      Specifies whether instance properties are required in CreateSession requests with this profile.

    • roleArns — (Array<String>)

      A list of IAM roles that this profile can assume in a CreateSession operation.

    • sessionPolicy — (String)

      A session policy that applies to the trust boundary of the vended session credentials.

    • tags — (Array<map>)

      The tags to attach to the profile.

      • key — required — (String)

        The tag key.

      • value — required — (String)

        The tag value.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • profile — (map)

        The state of the profile after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the profile was created.

        • createdBy — (String)

          The Amazon Web Services account that created the profile.

        • durationSeconds — (Integer)

          The number of seconds the vended session credentials are valid for.

        • enabled — (Boolean)

          Indicates whether the profile is enabled.

        • managedPolicyArns — (Array<String>)

          A list of managed policy ARNs that apply to the vended session credentials.

        • name — (String)

          The name of the profile.

        • profileArn — (String)

          The ARN of the profile.

        • profileId — (String)

          The unique identifier of the profile.

        • requireInstanceProperties — (Boolean)

          Specifies whether instance properties are required in CreateSession requests with this profile.

        • roleArns — (Array<String>)

          A list of IAM roles that this profile can assume in a CreateSession operation.

        • sessionPolicy — (String)

          A session policy that applies to the trust boundary of the vended session credentials.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the profile was last updated.

Returns:

  • (AWS.Request) —

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

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

Creates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.

Required permissions: rolesanywhere:CreateTrustAnchor.

Service Reference:

Examples:

Calling the createTrustAnchor operation

var params = {
  name: 'STRING_VALUE', /* required */
  source: { /* required */
    sourceData: {
      acmPcaArn: 'STRING_VALUE',
      x509CertificateData: 'STRING_VALUE'
    },
    sourceType: AWS_ACM_PCA | CERTIFICATE_BUNDLE | SELF_SIGNED_REPOSITORY
  },
  enabled: true || false,
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
rolesanywhere.createTrustAnchor(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: {}) —
    • enabled — (Boolean)

      Specifies whether the trust anchor is enabled.

    • name — (String)

      The name of the trust anchor.

    • source — (map)

      The trust anchor type and its related certificate data.

      • sourceData — (map)

        The data field of the trust anchor depending on its type.

        • acmPcaArn — (String)

          The root certificate of the Certificate Manager Private Certificate Authority specified by this ARN is used in trust validation for CreateSession operations. Included for trust anchors of type AWS_ACM_PCA.

        • x509CertificateData — (String)

          The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.

      • sourceType — (String)

        The type of the trust anchor.

        Possible values include:
        • "AWS_ACM_PCA"
        • "CERTIFICATE_BUNDLE"
        • "SELF_SIGNED_REPOSITORY"
    • tags — (Array<map>)

      The tags to attach to the trust anchor.

      • key — required — (String)

        The tag key.

      • value — required — (String)

        The tag value.

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:

      • trustAnchor — (map)

        The state of the trust anchor after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the trust anchor was created.

        • enabled — (Boolean)

          Indicates whether the trust anchor is enabled.

        • name — (String)

          The name of the trust anchor.

        • source — (map)

          The trust anchor type and its related certificate data.

          • sourceData — (map)

            The data field of the trust anchor depending on its type.

            • acmPcaArn — (String)

              The root certificate of the Certificate Manager Private Certificate Authority specified by this ARN is used in trust validation for CreateSession operations. Included for trust anchors of type AWS_ACM_PCA.

            • x509CertificateData — (String)

              The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.

          • sourceType — (String)

            The type of the trust anchor.

            Possible values include:
            • "AWS_ACM_PCA"
            • "CERTIFICATE_BUNDLE"
            • "SELF_SIGNED_REPOSITORY"
        • trustAnchorArn — (String)

          The ARN of the trust anchor.

        • trustAnchorId — (String)

          The unique identifier of the trust anchor.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the trust anchor was last updated.

Returns:

  • (AWS.Request) —

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

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

Deletes a certificate revocation list (CRL).

Required permissions: rolesanywhere:DeleteCrl.

Service Reference:

Examples:

Calling the deleteCrl operation

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

      The unique identifier of the certificate revocation list (CRL).

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:

      • crl — (map)

        The state of the certificate revocation list (CRL) after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was created.

        • crlArn — (String)

          The ARN of the certificate revocation list (CRL).

        • crlData — (Buffer, Typed Array, Blob, String)

          The state of the certificate revocation list (CRL) after a read or write operation.

        • crlId — (String)

          The unique identifier of the certificate revocation list (CRL).

        • enabled — (Boolean)

          Indicates whether the certificate revocation list (CRL) is enabled.

        • name — (String)

          The name of the certificate revocation list (CRL).

        • trustAnchorArn — (String)

          The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated.

Returns:

  • (AWS.Request) —

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

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

Deletes a profile.

Required permissions: rolesanywhere:DeleteProfile.

Service Reference:

Examples:

Calling the deleteProfile operation

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

Parameters:

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

      The unique identifier of the profile.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • profile — (map)

        The state of the profile after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the profile was created.

        • createdBy — (String)

          The Amazon Web Services account that created the profile.

        • durationSeconds — (Integer)

          The number of seconds the vended session credentials are valid for.

        • enabled — (Boolean)

          Indicates whether the profile is enabled.

        • managedPolicyArns — (Array<String>)

          A list of managed policy ARNs that apply to the vended session credentials.

        • name — (String)

          The name of the profile.

        • profileArn — (String)

          The ARN of the profile.

        • profileId — (String)

          The unique identifier of the profile.

        • requireInstanceProperties — (Boolean)

          Specifies whether instance properties are required in CreateSession requests with this profile.

        • roleArns — (Array<String>)

          A list of IAM roles that this profile can assume in a CreateSession operation.

        • sessionPolicy — (String)

          A session policy that applies to the trust boundary of the vended session credentials.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the profile was last updated.

Returns:

  • (AWS.Request) —

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

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

Deletes a trust anchor.

Required permissions: rolesanywhere:DeleteTrustAnchor.

Service Reference:

Examples:

Calling the deleteTrustAnchor operation

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

      The unique identifier of the trust anchor.

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:

      • trustAnchor — (map)

        The state of the trust anchor after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the trust anchor was created.

        • enabled — (Boolean)

          Indicates whether the trust anchor is enabled.

        • name — (String)

          The name of the trust anchor.

        • source — (map)

          The trust anchor type and its related certificate data.

          • sourceData — (map)

            The data field of the trust anchor depending on its type.

            • acmPcaArn — (String)

              The root certificate of the Certificate Manager Private Certificate Authority specified by this ARN is used in trust validation for CreateSession operations. Included for trust anchors of type AWS_ACM_PCA.

            • x509CertificateData — (String)

              The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.

          • sourceType — (String)

            The type of the trust anchor.

            Possible values include:
            • "AWS_ACM_PCA"
            • "CERTIFICATE_BUNDLE"
            • "SELF_SIGNED_REPOSITORY"
        • trustAnchorArn — (String)

          The ARN of the trust anchor.

        • trustAnchorId — (String)

          The unique identifier of the trust anchor.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the trust anchor was last updated.

Returns:

  • (AWS.Request) —

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

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

Disables a certificate revocation list (CRL).

Required permissions: rolesanywhere:DisableCrl.

Service Reference:

Examples:

Calling the disableCrl operation

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

      The unique identifier of the certificate revocation list (CRL).

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:

      • crl — (map)

        The state of the certificate revocation list (CRL) after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was created.

        • crlArn — (String)

          The ARN of the certificate revocation list (CRL).

        • crlData — (Buffer, Typed Array, Blob, String)

          The state of the certificate revocation list (CRL) after a read or write operation.

        • crlId — (String)

          The unique identifier of the certificate revocation list (CRL).

        • enabled — (Boolean)

          Indicates whether the certificate revocation list (CRL) is enabled.

        • name — (String)

          The name of the certificate revocation list (CRL).

        • trustAnchorArn — (String)

          The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated.

Returns:

  • (AWS.Request) —

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

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

Disables a profile. When disabled, CreateSession requests with this profile fail.

Required permissions: rolesanywhere:DisableProfile.

Service Reference:

Examples:

Calling the disableProfile operation

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

Parameters:

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

      The unique identifier of the profile.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • profile — (map)

        The state of the profile after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the profile was created.

        • createdBy — (String)

          The Amazon Web Services account that created the profile.

        • durationSeconds — (Integer)

          The number of seconds the vended session credentials are valid for.

        • enabled — (Boolean)

          Indicates whether the profile is enabled.

        • managedPolicyArns — (Array<String>)

          A list of managed policy ARNs that apply to the vended session credentials.

        • name — (String)

          The name of the profile.

        • profileArn — (String)

          The ARN of the profile.

        • profileId — (String)

          The unique identifier of the profile.

        • requireInstanceProperties — (Boolean)

          Specifies whether instance properties are required in CreateSession requests with this profile.

        • roleArns — (Array<String>)

          A list of IAM roles that this profile can assume in a CreateSession operation.

        • sessionPolicy — (String)

          A session policy that applies to the trust boundary of the vended session credentials.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the profile was last updated.

Returns:

  • (AWS.Request) —

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

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

Disables a trust anchor. When disabled, CreateSession requests specifying this trust anchor are unauthorized.

Required permissions: rolesanywhere:DisableTrustAnchor.

Service Reference:

Examples:

Calling the disableTrustAnchor operation

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

      The unique identifier of the trust anchor.

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:

      • trustAnchor — (map)

        The state of the trust anchor after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the trust anchor was created.

        • enabled — (Boolean)

          Indicates whether the trust anchor is enabled.

        • name — (String)

          The name of the trust anchor.

        • source — (map)

          The trust anchor type and its related certificate data.

          • sourceData — (map)

            The data field of the trust anchor depending on its type.

            • acmPcaArn — (String)

              The root certificate of the Certificate Manager Private Certificate Authority specified by this ARN is used in trust validation for CreateSession operations. Included for trust anchors of type AWS_ACM_PCA.

            • x509CertificateData — (String)

              The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.

          • sourceType — (String)

            The type of the trust anchor.

            Possible values include:
            • "AWS_ACM_PCA"
            • "CERTIFICATE_BUNDLE"
            • "SELF_SIGNED_REPOSITORY"
        • trustAnchorArn — (String)

          The ARN of the trust anchor.

        • trustAnchorId — (String)

          The unique identifier of the trust anchor.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the trust anchor was last updated.

Returns:

  • (AWS.Request) —

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

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

Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials.

Required permissions: rolesanywhere:EnableCrl.

Service Reference:

Examples:

Calling the enableCrl operation

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

      The unique identifier of the certificate revocation list (CRL).

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:

      • crl — (map)

        The state of the certificate revocation list (CRL) after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was created.

        • crlArn — (String)

          The ARN of the certificate revocation list (CRL).

        • crlData — (Buffer, Typed Array, Blob, String)

          The state of the certificate revocation list (CRL) after a read or write operation.

        • crlId — (String)

          The unique identifier of the certificate revocation list (CRL).

        • enabled — (Boolean)

          Indicates whether the certificate revocation list (CRL) is enabled.

        • name — (String)

          The name of the certificate revocation list (CRL).

        • trustAnchorArn — (String)

          The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated.

Returns:

  • (AWS.Request) —

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

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

Enables the roles in a profile to receive session credentials in CreateSession.

Required permissions: rolesanywhere:EnableProfile.

Service Reference:

Examples:

Calling the enableProfile operation

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

Parameters:

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

      The unique identifier of the profile.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • profile — (map)

        The state of the profile after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the profile was created.

        • createdBy — (String)

          The Amazon Web Services account that created the profile.

        • durationSeconds — (Integer)

          The number of seconds the vended session credentials are valid for.

        • enabled — (Boolean)

          Indicates whether the profile is enabled.

        • managedPolicyArns — (Array<String>)

          A list of managed policy ARNs that apply to the vended session credentials.

        • name — (String)

          The name of the profile.

        • profileArn — (String)

          The ARN of the profile.

        • profileId — (String)

          The unique identifier of the profile.

        • requireInstanceProperties — (Boolean)

          Specifies whether instance properties are required in CreateSession requests with this profile.

        • roleArns — (Array<String>)

          A list of IAM roles that this profile can assume in a CreateSession operation.

        • sessionPolicy — (String)

          A session policy that applies to the trust boundary of the vended session credentials.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the profile was last updated.

Returns:

  • (AWS.Request) —

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

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

Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation.

Required permissions: rolesanywhere:EnableTrustAnchor.

Service Reference:

Examples:

Calling the enableTrustAnchor operation

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

      The unique identifier of the trust anchor.

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:

      • trustAnchor — (map)

        The state of the trust anchor after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the trust anchor was created.

        • enabled — (Boolean)

          Indicates whether the trust anchor is enabled.

        • name — (String)

          The name of the trust anchor.

        • source — (map)

          The trust anchor type and its related certificate data.

          • sourceData — (map)

            The data field of the trust anchor depending on its type.

            • acmPcaArn — (String)

              The root certificate of the Certificate Manager Private Certificate Authority specified by this ARN is used in trust validation for CreateSession operations. Included for trust anchors of type AWS_ACM_PCA.

            • x509CertificateData — (String)

              The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.

          • sourceType — (String)

            The type of the trust anchor.

            Possible values include:
            • "AWS_ACM_PCA"
            • "CERTIFICATE_BUNDLE"
            • "SELF_SIGNED_REPOSITORY"
        • trustAnchorArn — (String)

          The ARN of the trust anchor.

        • trustAnchorId — (String)

          The unique identifier of the trust anchor.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the trust anchor was last updated.

Returns:

  • (AWS.Request) —

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

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

Gets a certificate revocation list (CRL).

Required permissions: rolesanywhere:GetCrl.

Service Reference:

Examples:

Calling the getCrl operation

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

      The unique identifier of the certificate revocation list (CRL).

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:

      • crl — (map)

        The state of the certificate revocation list (CRL) after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was created.

        • crlArn — (String)

          The ARN of the certificate revocation list (CRL).

        • crlData — (Buffer, Typed Array, Blob, String)

          The state of the certificate revocation list (CRL) after a read or write operation.

        • crlId — (String)

          The unique identifier of the certificate revocation list (CRL).

        • enabled — (Boolean)

          Indicates whether the certificate revocation list (CRL) is enabled.

        • name — (String)

          The name of the certificate revocation list (CRL).

        • trustAnchorArn — (String)

          The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated.

Returns:

  • (AWS.Request) —

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

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

Gets a profile.

Required permissions: rolesanywhere:GetProfile.

Service Reference:

Examples:

Calling the getProfile operation

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

Parameters:

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

      The unique identifier of the profile.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • profile — (map)

        The state of the profile after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the profile was created.

        • createdBy — (String)

          The Amazon Web Services account that created the profile.

        • durationSeconds — (Integer)

          The number of seconds the vended session credentials are valid for.

        • enabled — (Boolean)

          Indicates whether the profile is enabled.

        • managedPolicyArns — (Array<String>)

          A list of managed policy ARNs that apply to the vended session credentials.

        • name — (String)

          The name of the profile.

        • profileArn — (String)

          The ARN of the profile.

        • profileId — (String)

          The unique identifier of the profile.

        • requireInstanceProperties — (Boolean)

          Specifies whether instance properties are required in CreateSession requests with this profile.

        • roleArns — (Array<String>)

          A list of IAM roles that this profile can assume in a CreateSession operation.

        • sessionPolicy — (String)

          A session policy that applies to the trust boundary of the vended session credentials.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the profile was last updated.

Returns:

  • (AWS.Request) —

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

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

Gets a Subject. A Subject associates a certificate identity with authentication attempts by CreateSession. The Subject resources stores audit information such as status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.

Required permissions: rolesanywhere:GetSubject.

Service Reference:

Examples:

Calling the getSubject operation

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

      The unique identifier of the subject.

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:

      • subject — (map)

        The state of the subject after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the subject was created.

        • credentials — (Array<map>)

          The temporary session credentials vended at the last authenticating call with this Subject.

          • enabled — (Boolean)

            Indicates whether the credential is enabled.

          • failed — (Boolean)

            Indicates whether the CreateSession operation was successful.

          • issuer — (String)

            The fully qualified domain name of the issuing certificate for the presented end-entity certificate.

          • seenAt — (Date)

            The ISO-8601 time stamp of when the certificate was last used in a CreateSession operation.

          • serialNumber — (String)

            The serial number of the certificate.

          • x509CertificateData — (String)

            The PEM-encoded data of the certificate.

        • enabled — (Boolean)

          The enabled status of the subject.

        • instanceProperties — (Array<map>)

          The specified instance properties associated with the request.

          • failed — (Boolean)

            Indicates whether the CreateSession operation was successful.

          • properties — (map<String>)

            A list of instanceProperty objects.

          • seenAt — (Date)

            The ISO-8601 time stamp of when the certificate was last used in a CreateSession operation.

        • lastSeenAt — (Date)

          The ISO-8601 timestamp of the last time this Subject requested temporary session credentials.

        • subjectArn — (String)

          The ARN of the resource.

        • subjectId — (String)

          The id of the resource

        • updatedAt — (Date)

          The ISO-8601 timestamp when the subject was last updated.

        • x509Subject — (String)

          The x509 principal identifier of the authenticating certificate.

Returns:

  • (AWS.Request) —

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

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

Gets a trust anchor.

Required permissions: rolesanywhere:GetTrustAnchor.

Service Reference:

Examples:

Calling the getTrustAnchor operation

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

      The unique identifier of the trust anchor.

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:

      • trustAnchor — (map)

        The state of the trust anchor after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the trust anchor was created.

        • enabled — (Boolean)

          Indicates whether the trust anchor is enabled.

        • name — (String)

          The name of the trust anchor.

        • source — (map)

          The trust anchor type and its related certificate data.

          • sourceData — (map)

            The data field of the trust anchor depending on its type.

            • acmPcaArn — (String)

              The root certificate of the Certificate Manager Private Certificate Authority specified by this ARN is used in trust validation for CreateSession operations. Included for trust anchors of type AWS_ACM_PCA.

            • x509CertificateData — (String)

              The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.

          • sourceType — (String)

            The type of the trust anchor.

            Possible values include:
            • "AWS_ACM_PCA"
            • "CERTIFICATE_BUNDLE"
            • "SELF_SIGNED_REPOSITORY"
        • trustAnchorArn — (String)

          The ARN of the trust anchor.

        • trustAnchorId — (String)

          The unique identifier of the trust anchor.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the trust anchor was last updated.

Returns:

  • (AWS.Request) —

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

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

Imports the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.

Required permissions: rolesanywhere:ImportCrl.

Service Reference:

Examples:

Calling the importCrl operation

var params = {
  crlData: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  name: 'STRING_VALUE', /* required */
  trustAnchorArn: 'STRING_VALUE', /* required */
  enabled: true || false,
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
rolesanywhere.importCrl(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: {}) —
    • crlData — (Buffer, Typed Array, Blob, String)

      The x509 v3 specified certificate revocation list

    • enabled — (Boolean)

      Specifies whether the certificate revocation list (CRL) is enabled.

    • name — (String)

      The name of the certificate revocation list (CRL).

    • tags — (Array<map>)

      A list of tags to attach to the certificate revocation list (CRL).

      • key — required — (String)

        The tag key.

      • value — required — (String)

        The tag value.

    • trustAnchorArn — (String)

      The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • crl — (map)

        The state of the certificate revocation list (CRL) after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was created.

        • crlArn — (String)

          The ARN of the certificate revocation list (CRL).

        • crlData — (Buffer, Typed Array, Blob, String)

          The state of the certificate revocation list (CRL) after a read or write operation.

        • crlId — (String)

          The unique identifier of the certificate revocation list (CRL).

        • enabled — (Boolean)

          Indicates whether the certificate revocation list (CRL) is enabled.

        • name — (String)

          The name of the certificate revocation list (CRL).

        • trustAnchorArn — (String)

          The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated.

Returns:

  • (AWS.Request) —

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

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

Lists all Crls in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListCrls.

Service Reference:

Examples:

Calling the listCrls operation

var params = {
  nextToken: 'STRING_VALUE',
  pageSize: 'NUMBER_VALUE'
};
rolesanywhere.listCrls(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: {}) —
    • nextToken — (String)

      A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

    • pageSize — (Integer)

      The number of resources in the paginated list.

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:

      • crls — (Array<map>)

        A list of certificate revocation lists (CRL).

        • createdAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was created.

        • crlArn — (String)

          The ARN of the certificate revocation list (CRL).

        • crlData — (Buffer, Typed Array, Blob, String)

          The state of the certificate revocation list (CRL) after a read or write operation.

        • crlId — (String)

          The unique identifier of the certificate revocation list (CRL).

        • enabled — (Boolean)

          Indicates whether the certificate revocation list (CRL) is enabled.

        • name — (String)

          The name of the certificate revocation list (CRL).

        • trustAnchorArn — (String)

          The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated.

      • nextToken — (String)

        A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

Returns:

  • (AWS.Request) —

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

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

Lists all profiles in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListProfiles.

Service Reference:

Examples:

Calling the listProfiles operation

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

Parameters:

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

      A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

    • pageSize — (Integer)

      The number of resources in the paginated list.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • nextToken — (String)

        A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

      • profiles — (Array<map>)

        A list of profiles.

        • createdAt — (Date)

          The ISO-8601 timestamp when the profile was created.

        • createdBy — (String)

          The Amazon Web Services account that created the profile.

        • durationSeconds — (Integer)

          The number of seconds the vended session credentials are valid for.

        • enabled — (Boolean)

          Indicates whether the profile is enabled.

        • managedPolicyArns — (Array<String>)

          A list of managed policy ARNs that apply to the vended session credentials.

        • name — (String)

          The name of the profile.

        • profileArn — (String)

          The ARN of the profile.

        • profileId — (String)

          The unique identifier of the profile.

        • requireInstanceProperties — (Boolean)

          Specifies whether instance properties are required in CreateSession requests with this profile.

        • roleArns — (Array<String>)

          A list of IAM roles that this profile can assume in a CreateSession operation.

        • sessionPolicy — (String)

          A session policy that applies to the trust boundary of the vended session credentials.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the profile was last updated.

Returns:

  • (AWS.Request) —

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

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

Lists the subjects in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListSubjects.

Service Reference:

Examples:

Calling the listSubjects operation

var params = {
  nextToken: 'STRING_VALUE',
  pageSize: 'NUMBER_VALUE'
};
rolesanywhere.listSubjects(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: {}) —
    • nextToken — (String)

      A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

    • pageSize — (Integer)

      The number of resources in the paginated list.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • nextToken — (String)

        A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

      • subjects — (Array<map>)

        A list of subjects.

        • createdAt — (Date)

          The ISO-8601 time stamp of when the certificate was first used in a CreateSession operation.

        • enabled — (Boolean)

          The enabled status of the Subject.

        • lastSeenAt — (Date)

          The ISO-8601 time stamp of when the certificate was last used in a CreateSession operation.

        • subjectArn — (String)

          The ARN of the resource.

        • subjectId — (String)

          The id of the resource.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the subject was last updated.

        • x509Subject — (String)

          The x509 principal identifier of the authenticating certificate.

Returns:

  • (AWS.Request) —

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

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

Lists the tags attached to the resource.

Required permissions: rolesanywhere:ListTagsForResource.

Service Reference:

Examples:

Calling the listTagsForResource operation

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

        A list of tags attached to the resource.

        • key — required — (String)

          The tag key.

        • value — required — (String)

          The tag value.

Returns:

  • (AWS.Request) —

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

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

Lists the trust anchors in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListTrustAnchors.

Service Reference:

Examples:

Calling the listTrustAnchors operation

var params = {
  nextToken: 'STRING_VALUE',
  pageSize: 'NUMBER_VALUE'
};
rolesanywhere.listTrustAnchors(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: {}) —
    • nextToken — (String)

      A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

    • pageSize — (Integer)

      The number of resources in the paginated list.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • nextToken — (String)

        A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.

      • trustAnchors — (Array<map>)

        A list of trust anchors.

        • createdAt — (Date)

          The ISO-8601 timestamp when the trust anchor was created.

        • enabled — (Boolean)

          Indicates whether the trust anchor is enabled.

        • name — (String)

          The name of the trust anchor.

        • source — (map)

          The trust anchor type and its related certificate data.

          • sourceData — (map)

            The data field of the trust anchor depending on its type.

            • acmPcaArn — (String)

              The root certificate of the Certificate Manager Private Certificate Authority specified by this ARN is used in trust validation for CreateSession operations. Included for trust anchors of type AWS_ACM_PCA.

            • x509CertificateData — (String)

              The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.

          • sourceType — (String)

            The type of the trust anchor.

            Possible values include:
            • "AWS_ACM_PCA"
            • "CERTIFICATE_BUNDLE"
            • "SELF_SIGNED_REPOSITORY"
        • trustAnchorArn — (String)

          The ARN of the trust anchor.

        • trustAnchorId — (String)

          The unique identifier of the trust anchor.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the trust anchor was last updated.

Returns:

  • (AWS.Request) —

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

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

Attaches tags to a resource.

Required permissions: rolesanywhere:TagResource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
rolesanywhere.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 ARN of the resource.

    • tags — (Array<map>)

      The tags to attach to the resource.

      • key — required — (String)

        The tag key.

      • value — required — (String)

        The tag value.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

Returns:

  • (AWS.Request) —

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

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

Removes tags from the resource.

Required permissions: rolesanywhere:UntagResource.

Service Reference:

Examples:

Calling the untagResource operation

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

    • tagKeys — (Array<String>)

      A list of keys. Tag keys are the unique identifiers of tags.

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.

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

Updates the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.

Required permissions: rolesanywhere:UpdateCrl.

Service Reference:

Examples:

Calling the updateCrl operation

var params = {
  crlId: 'STRING_VALUE', /* required */
  crlData: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  name: 'STRING_VALUE'
};
rolesanywhere.updateCrl(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: {}) —
    • crlData — (Buffer, Typed Array, Blob, String)

      The x509 v3 specified certificate revocation list

    • crlId — (String)

      The unique identifier of the certificate revocation list (CRL).

    • name — (String)

      The name of the Crl.

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:

      • crl — (map)

        The state of the certificate revocation list (CRL) after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was created.

        • crlArn — (String)

          The ARN of the certificate revocation list (CRL).

        • crlData — (Buffer, Typed Array, Blob, String)

          The state of the certificate revocation list (CRL) after a read or write operation.

        • crlId — (String)

          The unique identifier of the certificate revocation list (CRL).

        • enabled — (Boolean)

          Indicates whether the certificate revocation list (CRL) is enabled.

        • name — (String)

          The name of the certificate revocation list (CRL).

        • trustAnchorArn — (String)

          The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated.

Returns:

  • (AWS.Request) —

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

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

Updates the profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can scope-down permissions with IAM managed policies.

Required permissions: rolesanywhere:UpdateProfile.

Service Reference:

Examples:

Calling the updateProfile operation

var params = {
  profileId: 'STRING_VALUE', /* required */
  durationSeconds: 'NUMBER_VALUE',
  managedPolicyArns: [
    'STRING_VALUE',
    /* more items */
  ],
  name: 'STRING_VALUE',
  roleArns: [
    'STRING_VALUE',
    /* more items */
  ],
  sessionPolicy: 'STRING_VALUE'
};
rolesanywhere.updateProfile(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: {}) —
    • durationSeconds — (Integer)

      The number of seconds the vended session credentials are valid for.

    • managedPolicyArns — (Array<String>)

      A list of managed policy ARNs that apply to the vended session credentials.

    • name — (String)

      The name of the profile.

    • profileId — (String)

      The unique identifier of the profile.

    • roleArns — (Array<String>)

      A list of IAM roles that this profile can assume in a CreateSession operation.

    • sessionPolicy — (String)

      A session policy that applies to the trust boundary of the vended session credentials.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • profile — (map)

        The state of the profile after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the profile was created.

        • createdBy — (String)

          The Amazon Web Services account that created the profile.

        • durationSeconds — (Integer)

          The number of seconds the vended session credentials are valid for.

        • enabled — (Boolean)

          Indicates whether the profile is enabled.

        • managedPolicyArns — (Array<String>)

          A list of managed policy ARNs that apply to the vended session credentials.

        • name — (String)

          The name of the profile.

        • profileArn — (String)

          The ARN of the profile.

        • profileId — (String)

          The unique identifier of the profile.

        • requireInstanceProperties — (Boolean)

          Specifies whether instance properties are required in CreateSession requests with this profile.

        • roleArns — (Array<String>)

          A list of IAM roles that this profile can assume in a CreateSession operation.

        • sessionPolicy — (String)

          A session policy that applies to the trust boundary of the vended session credentials.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the profile was last updated.

Returns:

  • (AWS.Request) —

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

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

Updates the trust anchor.You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.

Required permissions: rolesanywhere:UpdateTrustAnchor.

Service Reference:

Examples:

Calling the updateTrustAnchor operation

var params = {
  trustAnchorId: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE',
  source: {
    sourceData: {
      acmPcaArn: 'STRING_VALUE',
      x509CertificateData: 'STRING_VALUE'
    },
    sourceType: AWS_ACM_PCA | CERTIFICATE_BUNDLE | SELF_SIGNED_REPOSITORY
  }
};
rolesanywhere.updateTrustAnchor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The name of the trust anchor.

    • source — (map)

      The trust anchor type and its related certificate data.

      • sourceData — (map)

        The data field of the trust anchor depending on its type.

        • acmPcaArn — (String)

          The root certificate of the Certificate Manager Private Certificate Authority specified by this ARN is used in trust validation for CreateSession operations. Included for trust anchors of type AWS_ACM_PCA.

        • x509CertificateData — (String)

          The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.

      • sourceType — (String)

        The type of the trust anchor.

        Possible values include:
        • "AWS_ACM_PCA"
        • "CERTIFICATE_BUNDLE"
        • "SELF_SIGNED_REPOSITORY"
    • trustAnchorId — (String)

      The unique identifier of the trust anchor.

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:

      • trustAnchor — (map)

        The state of the trust anchor after a read or write operation.

        • createdAt — (Date)

          The ISO-8601 timestamp when the trust anchor was created.

        • enabled — (Boolean)

          Indicates whether the trust anchor is enabled.

        • name — (String)

          The name of the trust anchor.

        • source — (map)

          The trust anchor type and its related certificate data.

          • sourceData — (map)

            The data field of the trust anchor depending on its type.

            • acmPcaArn — (String)

              The root certificate of the Certificate Manager Private Certificate Authority specified by this ARN is used in trust validation for CreateSession operations. Included for trust anchors of type AWS_ACM_PCA.

            • x509CertificateData — (String)

              The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.

          • sourceType — (String)

            The type of the trust anchor.

            Possible values include:
            • "AWS_ACM_PCA"
            • "CERTIFICATE_BUNDLE"
            • "SELF_SIGNED_REPOSITORY"
        • trustAnchorArn — (String)

          The ARN of the trust anchor.

        • trustAnchorId — (String)

          The unique identifier of the trust anchor.

        • updatedAt — (Date)

          The ISO-8601 timestamp when the trust anchor was last updated.

Returns:

  • (AWS.Request) —

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