IAMRolesAnywhere / Client / enable_trust_anchor

enable_trust_anchor

IAMRolesAnywhere.Client.enable_trust_anchor(**kwargs)

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

Required permissions: rolesanywhere:EnableTrustAnchor.

See also: AWS API Documentation

Request Syntax

response = client.enable_trust_anchor(
    trustAnchorId='string'
)
Parameters:

trustAnchorId (string) –

[REQUIRED]

The unique identifier of the trust anchor.

Return type:

dict

Returns:

Response Syntax

{
    'trustAnchor': {
        'trustAnchorId': 'string',
        'trustAnchorArn': 'string',
        'name': 'string',
        'source': {
            'sourceType': 'AWS_ACM_PCA'|'CERTIFICATE_BUNDLE'|'SELF_SIGNED_REPOSITORY',
            'sourceData': {
                'x509CertificateData': 'string',
                'acmPcaArn': 'string'
            }
        },
        'enabled': True|False,
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'notificationSettings': [
            {
                'enabled': True|False,
                'event': 'CA_CERTIFICATE_EXPIRY'|'END_ENTITY_CERTIFICATE_EXPIRY',
                'threshold': 123,
                'channel': 'ALL',
                'configuredBy': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • trustAnchor (dict) –

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

      • trustAnchorId (string) –

        The unique identifier of the trust anchor.

      • trustAnchorArn (string) –

        The ARN of the trust anchor.

      • name (string) –

        The name of the trust anchor.

      • source (dict) –

        The trust anchor type and its related certificate data.

        • sourceType (string) –

          The type of the trust anchor.

        • sourceData (dict) –

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

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: x509CertificateData, acmPcaArn. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • x509CertificateData (string) –

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

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

      • enabled (boolean) –

        Indicates whether the trust anchor is enabled.

      • createdAt (datetime) –

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

      • updatedAt (datetime) –

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

      • notificationSettings (list) –

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

        • (dict) –

          The state of a notification setting.

          A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify.

          • enabled (boolean) –

            Indicates whether the notification setting is enabled.

          • event (string) –

            The event to which this notification setting is applied.

          • threshold (integer) –

            The number of days before a notification event.

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

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

Exceptions