IAMRolesAnywhere / Client / delete_trust_anchor

delete_trust_anchor#

IAMRolesAnywhere.Client.delete_trust_anchor(**kwargs)#

Deletes a trust anchor.

Required permissions: rolesanywhere:DeleteTrustAnchor.

See also: AWS API Documentation

Request Syntax

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

trustAnchorId (string) –

[REQUIRED]

The unique identifier of the trust anchor.

Return type:

dict

Returns:

Response Syntax

{
    'trustAnchor': {
        'createdAt': datetime(2015, 1, 1),
        'enabled': True|False,
        'name': 'string',
        'source': {
            'sourceData': {
                'acmPcaArn': 'string',
                'x509CertificateData': 'string'
            },
            'sourceType': 'AWS_ACM_PCA'|'CERTIFICATE_BUNDLE'|'SELF_SIGNED_REPOSITORY'
        },
        'trustAnchorArn': 'string',
        'trustAnchorId': 'string',
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • trustAnchor (dict) –

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

      • createdAt (datetime) –

        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 (dict) –

        The trust anchor type and its related certificate data.

        • 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: acmPcaArn, x509CertificateData. 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'}
          
          • 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.

      • trustAnchorArn (string) –

        The ARN of the trust anchor.

      • trustAnchorId (string) –

        The unique identifier of the trust anchor.

      • updatedAt (datetime) –

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

Exceptions

  • IAMRolesAnywhere.Client.exceptions.ResourceNotFoundException

  • IAMRolesAnywhere.Client.exceptions.AccessDeniedException