Class: AWS.RolesAnywhere

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,
  notificationSettings: [
    {
      enabled: true || false, /* required */
      event: CA_CERTIFICATE_EXPIRY | END_ENTITY_CERTIFICATE_EXPIRY, /* required */
      channel: ALL,
      threshold: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  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.

  • notificationSettings — (Array<map>)

    A list of notification settings to be associated to the trust anchor.

    • channel — (String)

      The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

      Note: In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
      Possible values include:
      • "ALL"
    • enabled — required — (Boolean)

      Indicates whether the notification setting is enabled.

    • event — required — (String)

      The event to which this notification setting is applied.

      Possible values include:
      • "CA_CERTIFICATE_EXPIRY"
      • "END_ENTITY_CERTIFICATE_EXPIRY"
    • threshold — (Integer)

      The number of days before a notification event. This value is required for a notification setting that is enabled.

  • 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 Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. 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.

      • notificationSettings — (Array<map>)

        A list of notification settings to be associated to the trust anchor.

        • channel — (String)

          The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

          Note: In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
          Possible values include:
          • "ALL"
        • configuredBy — (String)

          The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is rolesanywhere.amazonaws.com, and for customized notifications settings, it is the respective account ID.

        • enabled — required — (Boolean)

          Indicates whether the notification setting is enabled.

        • event — required — (String)

          The event to which this notification setting is applied.

          Possible values include:
          • "CA_CERTIFICATE_EXPIRY"
          • "END_ENTITY_CERTIFICATE_EXPIRY"
        • threshold — (Integer)

          The number of days before a notification event.

      • 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 Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. 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.

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.

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)

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • 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 temporary credential requests with this profile.

      • roleArns — (Array<String>)

        A list of IAM roles that this profile can assume in a temporary credential request.

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

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.

      • notificationSettings — (Array<map>)

        A list of notification settings to be associated to the trust anchor.

        • channel — (String)

          The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

          Note: In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
          Possible values include:
          • "ALL"
        • configuredBy — (String)

          The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is rolesanywhere.amazonaws.com, and for customized notifications settings, it is the respective account ID.

        • enabled — required — (Boolean)

          Indicates whether the notification setting is enabled.

        • event — required — (String)

          The event to which this notification setting is applied.

          Possible values include:
          • "CA_CERTIFICATE_EXPIRY"
          • "END_ENTITY_CERTIFICATE_EXPIRY"
        • threshold — (Integer)

          The number of days before a notification event.

      • 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 Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. 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.

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.

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)

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • 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 temporary credential requests with this profile.

      • roleArns — (Array<String>)

        A list of IAM roles that this profile can assume in a temporary credential request.

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

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.

      • notificationSettings — (Array<map>)

        A list of notification settings to be associated to the trust anchor.

        • channel — (String)

          The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

          Note: In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
          Possible values include:
          • "ALL"
        • configuredBy — (String)

          The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is rolesanywhere.amazonaws.com, and for customized notifications settings, it is the respective account ID.

        • enabled — required — (Boolean)

          Indicates whether the notification setting is enabled.

        • event — required — (String)

          The event to which this notification setting is applied.

          Possible values include:
          • "CA_CERTIFICATE_EXPIRY"
          • "END_ENTITY_CERTIFICATE_EXPIRY"
        • threshold — (Integer)

          The number of days before a notification event.

      • 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 Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. 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.

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.

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)

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • 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 temporary credential requests with this profile.

      • roleArns — (Array<String>)

        A list of IAM roles that this profile can assume in a temporary credential request.

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

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.

      • notificationSettings — (Array<map>)

        A list of notification settings to be associated to the trust anchor.

        • channel — (String)

          The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

          Note: In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
          Possible values include:
          • "ALL"
        • configuredBy — (String)

          The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is rolesanywhere.amazonaws.com, and for customized notifications settings, it is the respective account ID.

        • enabled — required — (Boolean)

          Indicates whether the notification setting is enabled.

        • event — required — (String)

          The event to which this notification setting is applied.

          Possible values include:
          • "CA_CERTIFICATE_EXPIRY"
          • "END_ENTITY_CERTIFICATE_EXPIRY"
        • threshold — (Integer)

          The number of days before a notification event.

      • 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 Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. 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.

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.

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)

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • 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 temporary credential requests with this profile.

      • roleArns — (Array<String>)

        A list of IAM roles that this profile can assume in a temporary credential request.

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

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 temporary credential request 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 temporary credential request.

        • 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 temporary credential request 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 temporary credential request.

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

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.

      • notificationSettings — (Array<map>)

        A list of notification settings to be associated to the trust anchor.

        • channel — (String)

          The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

          Note: In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
          Possible values include:
          • "ALL"
        • configuredBy — (String)

          The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is rolesanywhere.amazonaws.com, and for customized notifications settings, it is the respective account ID.

        • enabled — required — (Boolean)

          Indicates whether the notification setting is enabled.

        • event — required — (String)

          The event to which this notification setting is applied.

          Possible values include:
          • "CA_CERTIFICATE_EXPIRY"
          • "END_ENTITY_CERTIFICATE_EXPIRY"
        • threshold — (Integer)

          The number of days before a notification event.

      • 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 Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. 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.

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 (CRL).

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

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 request did not show all results. To get the next results, make the request 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 request did not show all results. To get the next results, make the request again with this value.

Returns:

• (AWS.Request) —

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

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 request did not show all results. To get the next results, make the request 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 request did not show all results. To get the next results, make the request 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)

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • 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 temporary credential requests with this profile.

      • roleArns — (Array<String>)

        A list of IAM roles that this profile can assume in a temporary credential request.

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

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 request did not show all results. To get the next results, make the request 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 request did not show all results. To get the next results, make the request 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 temporary credential request.

      • enabled — (Boolean)

        The enabled status of the subject.

      • lastSeenAt — (Date)

        The ISO-8601 time stamp of when the certificate was last used in a temporary credential request.

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

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.

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 request did not show all results. To get the next results, make the request 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 request did not show all results. To get the next results, make the request 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.

      • notificationSettings — (Array<map>)

        A list of notification settings to be associated to the trust anchor.

        • channel — (String)

          The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

          Note: In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
          Possible values include:
          • "ALL"
        • configuredBy — (String)

          The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is rolesanywhere.amazonaws.com, and for customized notifications settings, it is the respective account ID.

        • enabled — required — (Boolean)

          Indicates whether the notification setting is enabled.

        • event — required — (String)

          The event to which this notification setting is applied.

          Possible values include:
          • "CA_CERTIFICATE_EXPIRY"
          • "END_ENTITY_CERTIFICATE_EXPIRY"
        • threshold — (Integer)

          The number of days before a notification event.

      • 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 Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. 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.

var params = {
  notificationSettings: [ /* required */
    {
      enabled: true || false, /* required */
      event: CA_CERTIFICATE_EXPIRY | END_ENTITY_CERTIFICATE_EXPIRY, /* required */
      channel: ALL,
      threshold: 'NUMBER_VALUE'
    },
    /* more items */
  ],
  trustAnchorId: 'STRING_VALUE' /* required */
};
rolesanywhere.putNotificationSettings(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: {}) —
  • notificationSettings — (Array<map>)

    A list of notification settings to be associated to the trust anchor.

    • channel — (String)

      The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

      Note: In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
      Possible values include:
      • "ALL"
    • enabled — required — (Boolean)

      Indicates whether the notification setting is enabled.

    • event — required — (String)

      The event to which this notification setting is applied.

      Possible values include:
      • "CA_CERTIFICATE_EXPIRY"
      • "END_ENTITY_CERTIFICATE_EXPIRY"
    • threshold — (Integer)

      The number of days before a notification event. This value is required for a notification setting that is enabled.

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

      • notificationSettings — (Array<map>)

        A list of notification settings to be associated to the trust anchor.

        • channel — (String)

          The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

          Note: In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
          Possible values include:
          • "ALL"
        • configuredBy — (String)

          The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is rolesanywhere.amazonaws.com, and for customized notifications settings, it is the respective account ID.

        • enabled — required — (Boolean)

          Indicates whether the notification setting is enabled.

        • event — required — (String)

          The event to which this notification setting is applied.

          Possible values include:
          • "CA_CERTIFICATE_EXPIRY"
          • "END_ENTITY_CERTIFICATE_EXPIRY"
        • threshold — (Integer)

          The number of days before a notification event.

      • 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 Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. 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.

var params = {
  notificationSettingKeys: [ /* required */
    {
      event: CA_CERTIFICATE_EXPIRY | END_ENTITY_CERTIFICATE_EXPIRY, /* required */
      channel: ALL
    },
    /* more items */
  ],
  trustAnchorId: 'STRING_VALUE' /* required */
};
rolesanywhere.resetNotificationSettings(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: {}) —
  • notificationSettingKeys — (Array<map>)

    A list of notification setting keys to reset. A notification setting key includes the event and the channel.

    • channel — (String)

      The specified channel of notification.

      Possible values include:
      • "ALL"
    • event — required — (String)

      The notification setting event to reset.

      Possible values include:
      • "CA_CERTIFICATE_EXPIRY"
      • "END_ENTITY_CERTIFICATE_EXPIRY"
  • 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.

      • notificationSettings — (Array<map>)

        A list of notification settings to be associated to the trust anchor.

        • channel — (String)

          The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

          Note: In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
          Possible values include:
          • "ALL"
        • configuredBy — (String)

          The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is rolesanywhere.amazonaws.com, and for customized notifications settings, it is the respective account ID.

        • enabled — required — (Boolean)

          Indicates whether the notification setting is enabled.

        • event — required — (String)

          The event to which this notification setting is applied.

          Possible values include:
          • "CA_CERTIFICATE_EXPIRY"
          • "END_ENTITY_CERTIFICATE_EXPIRY"
        • threshold — (Integer)

          The number of days before a notification event.

      • 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 Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. 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.

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.

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.

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 (CRL).

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

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)

    Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

  • 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 temporary credential request.

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

        Used to determine how long sessions vended using this profile are valid for. See the Expiration section of the CreateSession API documentation page for more details. In requests, if this value is not provided, the default value will be 3600.

      • 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 temporary credential requests with this profile.

      • roleArns — (Array<String>)

        A list of IAM roles that this profile can assume in a temporary credential request.

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

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 Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. 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.

      • notificationSettings — (Array<map>)

        A list of notification settings to be associated to the trust anchor.

        • channel — (String)

          The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

          Note: In the absence of a specific channel, IAM Roles Anywhere applies this setting to 'ALL' channels.
          Possible values include:
          • "ALL"
        • configuredBy — (String)

          The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is rolesanywhere.amazonaws.com, and for customized notifications settings, it is the respective account ID.

        • enabled — required — (Boolean)

          Indicates whether the notification setting is enabled.

        • event — required — (String)

          The event to which this notification setting is applied.

          Possible values include:
          • "CA_CERTIFICATE_EXPIRY"
          • "END_ENTITY_CERTIFICATE_EXPIRY"
        • threshold — (Integer)

          The number of days before a notification event.

      • 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 Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. 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.