CreateProfile

$result = $client->createProfile([/* ... */]);
$promise = $client->createProfileAsync([/* ... */]);

Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.

Required permissions: rolesanywhere:CreateProfile.

Parameter Syntax

$result = $client->createProfile([
    'acceptRoleSessionName' => true || false,
    'durationSeconds' => <integer>,
    'enabled' => true || false,
    'managedPolicyArns' => ['<string>', ...],
    'name' => '<string>', // REQUIRED
    'requireInstanceProperties' => true || false,
    'roleArns' => ['<string>', ...], // REQUIRED
    'sessionPolicy' => '<string>',
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'profile' => [
        'acceptRoleSessionName' => true || false,
        'attributeMappings' => [
            [
                'certificateField' => 'x509Subject|x509Issuer|x509SAN',
                'mappingRules' => [
                    [
                        'specifier' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateTrustAnchor

$result = $client->createTrustAnchor([/* ... */]);
$promise = $client->createTrustAnchorAsync([/* ... */]);

Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA). You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.

Required permissions: rolesanywhere:CreateTrustAnchor.

Parameter Syntax

$result = $client->createTrustAnchor([
    'enabled' => true || false,
    'name' => '<string>', // REQUIRED
    'notificationSettings' => [
        [
            'channel' => 'ALL',
            'enabled' => true || false, // REQUIRED
            'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY', // REQUIRED
            'threshold' => <integer>,
        ],
        // ...
    ],
    'source' => [ // REQUIRED
        'sourceData' => [
            'acmPcaArn' => '<string>',
            'x509CertificateData' => '<string>',
        ],
        'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
    ],
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'notificationSettings' => [
            [
                'channel' => 'ALL',
                'configuredBy' => '<string>',
                'enabled' => true || false,
                'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY',
                'threshold' => <integer>,
            ],
            // ...
        ],
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteAttributeMapping

$result = $client->deleteAttributeMapping([/* ... */]);
$promise = $client->deleteAttributeMappingAsync([/* ... */]);

Delete an entry from the attribute mapping rules enforced by a given profile.

Parameter Syntax

$result = $client->deleteAttributeMapping([
    'certificateField' => 'x509Subject|x509Issuer|x509SAN', // REQUIRED
    'profileId' => '<string>', // REQUIRED
    'specifiers' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'profile' => [
        'acceptRoleSessionName' => true || false,
        'attributeMappings' => [
            [
                'certificateField' => 'x509Subject|x509Issuer|x509SAN',
                'mappingRules' => [
                    [
                        'specifier' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteCrl

$result = $client->deleteCrl([/* ... */]);
$promise = $client->deleteCrlAsync([/* ... */]);

Deletes a certificate revocation list (CRL).

Required permissions: rolesanywhere:DeleteCrl.

Parameter Syntax

$result = $client->deleteCrl([
    'crlId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteProfile

$result = $client->deleteProfile([/* ... */]);
$promise = $client->deleteProfileAsync([/* ... */]);

Deletes a profile.

Required permissions: rolesanywhere:DeleteProfile.

Parameter Syntax

$result = $client->deleteProfile([
    'profileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'profile' => [
        'acceptRoleSessionName' => true || false,
        'attributeMappings' => [
            [
                'certificateField' => 'x509Subject|x509Issuer|x509SAN',
                'mappingRules' => [
                    [
                        'specifier' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteTrustAnchor

$result = $client->deleteTrustAnchor([/* ... */]);
$promise = $client->deleteTrustAnchorAsync([/* ... */]);

Deletes a trust anchor.

Required permissions: rolesanywhere:DeleteTrustAnchor.

Parameter Syntax

$result = $client->deleteTrustAnchor([
    'trustAnchorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'notificationSettings' => [
            [
                'channel' => 'ALL',
                'configuredBy' => '<string>',
                'enabled' => true || false,
                'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY',
                'threshold' => <integer>,
            ],
            // ...
        ],
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

DisableCrl

$result = $client->disableCrl([/* ... */]);
$promise = $client->disableCrlAsync([/* ... */]);

Disables a certificate revocation list (CRL).

Required permissions: rolesanywhere:DisableCrl.

Parameter Syntax

$result = $client->disableCrl([
    'crlId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

DisableProfile

$result = $client->disableProfile([/* ... */]);
$promise = $client->disableProfileAsync([/* ... */]);

Disables a profile. When disabled, temporary credential requests with this profile fail.

Required permissions: rolesanywhere:DisableProfile.

Parameter Syntax

$result = $client->disableProfile([
    'profileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'profile' => [
        'acceptRoleSessionName' => true || false,
        'attributeMappings' => [
            [
                'certificateField' => 'x509Subject|x509Issuer|x509SAN',
                'mappingRules' => [
                    [
                        'specifier' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

DisableTrustAnchor

$result = $client->disableTrustAnchor([/* ... */]);
$promise = $client->disableTrustAnchorAsync([/* ... */]);

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

Required permissions: rolesanywhere:DisableTrustAnchor.

Parameter Syntax

$result = $client->disableTrustAnchor([
    'trustAnchorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'notificationSettings' => [
            [
                'channel' => 'ALL',
                'configuredBy' => '<string>',
                'enabled' => true || false,
                'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY',
                'threshold' => <integer>,
            ],
            // ...
        ],
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

EnableCrl

$result = $client->enableCrl([/* ... */]);
$promise = $client->enableCrlAsync([/* ... */]);

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

Required permissions: rolesanywhere:EnableCrl.

Parameter Syntax

$result = $client->enableCrl([
    'crlId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

EnableProfile

$result = $client->enableProfile([/* ... */]);
$promise = $client->enableProfileAsync([/* ... */]);

Enables temporary credential requests for a profile.

Required permissions: rolesanywhere:EnableProfile.

Parameter Syntax

$result = $client->enableProfile([
    'profileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'profile' => [
        'acceptRoleSessionName' => true || false,
        'attributeMappings' => [
            [
                'certificateField' => 'x509Subject|x509Issuer|x509SAN',
                'mappingRules' => [
                    [
                        'specifier' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

EnableTrustAnchor

$result = $client->enableTrustAnchor([/* ... */]);
$promise = $client->enableTrustAnchorAsync([/* ... */]);

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

Required permissions: rolesanywhere:EnableTrustAnchor.

Parameter Syntax

$result = $client->enableTrustAnchor([
    'trustAnchorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'notificationSettings' => [
            [
                'channel' => 'ALL',
                'configuredBy' => '<string>',
                'enabled' => true || false,
                'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY',
                'threshold' => <integer>,
            ],
            // ...
        ],
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetCrl

$result = $client->getCrl([/* ... */]);
$promise = $client->getCrlAsync([/* ... */]);

Gets a certificate revocation list (CRL).

Required permissions: rolesanywhere:GetCrl.

Parameter Syntax

$result = $client->getCrl([
    'crlId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

GetProfile

$result = $client->getProfile([/* ... */]);
$promise = $client->getProfileAsync([/* ... */]);

Gets a profile.

Required permissions: rolesanywhere:GetProfile.

Parameter Syntax

$result = $client->getProfile([
    'profileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'profile' => [
        'acceptRoleSessionName' => true || false,
        'attributeMappings' => [
            [
                'certificateField' => 'x509Subject|x509Issuer|x509SAN',
                'mappingRules' => [
                    [
                        'specifier' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetSubject

$result = $client->getSubject([/* ... */]);
$promise = $client->getSubjectAsync([/* ... */]);

Gets a subject, which associates a certificate identity with authentication attempts. The subject stores auditing information such as the 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.

Parameter Syntax

$result = $client->getSubject([
    'subjectId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'subject' => [
        'createdAt' => <DateTime>,
        'credentials' => [
            [
                'enabled' => true || false,
                'failed' => true || false,
                'issuer' => '<string>',
                'seenAt' => <DateTime>,
                'serialNumber' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            // ...
        ],
        'enabled' => true || false,
        'instanceProperties' => [
            [
                'failed' => true || false,
                'properties' => ['<string>', ...],
                'seenAt' => <DateTime>,
            ],
            // ...
        ],
        'lastSeenAt' => <DateTime>,
        'subjectArn' => '<string>',
        'subjectId' => '<string>',
        'updatedAt' => <DateTime>,
        'x509Subject' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetTrustAnchor

$result = $client->getTrustAnchor([/* ... */]);
$promise = $client->getTrustAnchorAsync([/* ... */]);

Gets a trust anchor.

Required permissions: rolesanywhere:GetTrustAnchor.

Parameter Syntax

$result = $client->getTrustAnchor([
    'trustAnchorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'notificationSettings' => [
            [
                'channel' => 'ALL',
                'configuredBy' => '<string>',
                'enabled' => true || false,
                'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY',
                'threshold' => <integer>,
            ],
            // ...
        ],
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ImportCrl

$result = $client->importCrl([/* ... */]);
$promise = $client->importCrlAsync([/* ... */]);

Imports the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate Authority (CA).In order to be properly imported, a CRL must be in PEM format. IAM Roles Anywhere validates against the CRL before issuing credentials.

Required permissions: rolesanywhere:ImportCrl.

Parameter Syntax

$result = $client->importCrl([
    'crlData' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'enabled' => true || false,
    'name' => '<string>', // REQUIRED
    'tags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'trustAnchorArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListCrls

$result = $client->listCrls([/* ... */]);
$promise = $client->listCrlsAsync([/* ... */]);

Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region.

Required permissions: rolesanywhere:ListCrls.

Parameter Syntax

$result = $client->listCrls([
    'nextToken' => '<string>',
    'pageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'crls' => [
        [
            'createdAt' => <DateTime>,
            'crlArn' => '<string>',
            'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
            'crlId' => '<string>',
            'enabled' => true || false,
            'name' => '<string>',
            'trustAnchorArn' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Validation exception error.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListProfiles

$result = $client->listProfiles([/* ... */]);
$promise = $client->listProfilesAsync([/* ... */]);

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

Required permissions: rolesanywhere:ListProfiles.

Parameter Syntax

$result = $client->listProfiles([
    'nextToken' => '<string>',
    'pageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'profiles' => [
        [
            'acceptRoleSessionName' => true || false,
            'attributeMappings' => [
                [
                    'certificateField' => 'x509Subject|x509Issuer|x509SAN',
                    'mappingRules' => [
                        [
                            'specifier' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'durationSeconds' => <integer>,
            'enabled' => true || false,
            'managedPolicyArns' => ['<string>', ...],
            'name' => '<string>',
            'profileArn' => '<string>',
            'profileId' => '<string>',
            'requireInstanceProperties' => true || false,
            'roleArns' => ['<string>', ...],
            'sessionPolicy' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListSubjects

$result = $client->listSubjects([/* ... */]);
$promise = $client->listSubjectsAsync([/* ... */]);

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

Required permissions: rolesanywhere:ListSubjects.

Parameter Syntax

$result = $client->listSubjects([
    'nextToken' => '<string>',
    'pageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'subjects' => [
        [
            'createdAt' => <DateTime>,
            'enabled' => true || false,
            'lastSeenAt' => <DateTime>,
            'subjectArn' => '<string>',
            'subjectId' => '<string>',
            'updatedAt' => <DateTime>,
            'x509Subject' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags attached to the resource.

Required permissions: rolesanywhere:ListTagsForResource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListTrustAnchors

$result = $client->listTrustAnchors([/* ... */]);
$promise = $client->listTrustAnchorsAsync([/* ... */]);

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

Required permissions: rolesanywhere:ListTrustAnchors.

Parameter Syntax

$result = $client->listTrustAnchors([
    'nextToken' => '<string>',
    'pageSize' => <integer>,
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'trustAnchors' => [
        [
            'createdAt' => <DateTime>,
            'enabled' => true || false,
            'name' => '<string>',
            'notificationSettings' => [
                [
                    'channel' => 'ALL',
                    'configuredBy' => '<string>',
                    'enabled' => true || false,
                    'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY',
                    'threshold' => <integer>,
                ],
                // ...
            ],
            'source' => [
                'sourceData' => [
                    'acmPcaArn' => '<string>',
                    'x509CertificateData' => '<string>',
                ],
                'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
            ],
            'trustAnchorArn' => '<string>',
            'trustAnchorId' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

AccessDeniedException:

You do not have sufficient access to perform this action.

PutAttributeMapping

$result = $client->putAttributeMapping([/* ... */]);
$promise = $client->putAttributeMappingAsync([/* ... */]);

Put an entry in the attribute mapping rules that will be enforced by a given profile. A mapping specifies a certificate field and one or more specifiers that have contextual meanings.

Parameter Syntax

$result = $client->putAttributeMapping([
    'certificateField' => 'x509Subject|x509Issuer|x509SAN', // REQUIRED
    'mappingRules' => [ // REQUIRED
        [
            'specifier' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'profileId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'profile' => [
        'acceptRoleSessionName' => true || false,
        'attributeMappings' => [
            [
                'certificateField' => 'x509Subject|x509Issuer|x509SAN',
                'mappingRules' => [
                    [
                        'specifier' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

PutNotificationSettings

$result = $client->putNotificationSettings([/* ... */]);
$promise = $client->putNotificationSettingsAsync([/* ... */]);

Attaches a list of notification settings to a trust anchor.

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

Required permissions: rolesanywhere:PutNotificationSettings.

Parameter Syntax

$result = $client->putNotificationSettings([
    'notificationSettings' => [ // REQUIRED
        [
            'channel' => 'ALL',
            'enabled' => true || false, // REQUIRED
            'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY', // REQUIRED
            'threshold' => <integer>,
        ],
        // ...
    ],
    'trustAnchorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'notificationSettings' => [
            [
                'channel' => 'ALL',
                'configuredBy' => '<string>',
                'enabled' => true || false,
                'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY',
                'threshold' => <integer>,
            ],
            // ...
        ],
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResetNotificationSettings

$result = $client->resetNotificationSettings([/* ... */]);
$promise = $client->resetNotificationSettingsAsync([/* ... */]);

Resets the custom notification setting to IAM Roles Anywhere default setting.

Required permissions: rolesanywhere:ResetNotificationSettings.

Parameter Syntax

$result = $client->resetNotificationSettings([
    'notificationSettingKeys' => [ // REQUIRED
        [
            'channel' => 'ALL',
            'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY', // REQUIRED
        ],
        // ...
    ],
    'trustAnchorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'notificationSettings' => [
            [
                'channel' => 'ALL',
                'configuredBy' => '<string>',
                'enabled' => true || false,
                'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY',
                'threshold' => <integer>,
            ],
            // ...
        ],
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Attaches tags to a resource.

Required permissions: rolesanywhere:TagResource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Validation exception error.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

TooManyTagsException:

Too many tags.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from the resource.

Required permissions: rolesanywhere:UntagResource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Validation exception error.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

UpdateCrl

$result = $client->updateCrl([/* ... */]);
$promise = $client->updateCrlAsync([/* ... */]);

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

Required permissions: rolesanywhere:UpdateCrl.

Parameter Syntax

$result = $client->updateCrl([
    'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
    'crlId' => '<string>', // REQUIRED
    'name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'crl' => [
        'createdAt' => <DateTime>,
        'crlArn' => '<string>',
        'crlData' => <string || resource || Psr\Http\Message\StreamInterface>,
        'crlId' => '<string>',
        'enabled' => true || false,
        'name' => '<string>',
        'trustAnchorArn' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

UpdateProfile

$result = $client->updateProfile([/* ... */]);
$promise = $client->updateProfileAsync([/* ... */]);

Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume. You use profiles to intersect permissions with IAM managed policies.

Required permissions: rolesanywhere:UpdateProfile.

Parameter Syntax

$result = $client->updateProfile([
    'acceptRoleSessionName' => true || false,
    'durationSeconds' => <integer>,
    'managedPolicyArns' => ['<string>', ...],
    'name' => '<string>',
    'profileId' => '<string>', // REQUIRED
    'roleArns' => ['<string>', ...],
    'sessionPolicy' => '<string>',
]);

Parameter Details

Result Syntax

[
    'profile' => [
        'acceptRoleSessionName' => true || false,
        'attributeMappings' => [
            [
                'certificateField' => 'x509Subject|x509Issuer|x509SAN',
                'mappingRules' => [
                    [
                        'specifier' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'createdAt' => <DateTime>,
        'createdBy' => '<string>',
        'durationSeconds' => <integer>,
        'enabled' => true || false,
        'managedPolicyArns' => ['<string>', ...],
        'name' => '<string>',
        'profileArn' => '<string>',
        'profileId' => '<string>',
        'requireInstanceProperties' => true || false,
        'roleArns' => ['<string>', ...],
        'sessionPolicy' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.

UpdateTrustAnchor

$result = $client->updateTrustAnchor([/* ... */]);
$promise = $client->updateTrustAnchorAsync([/* ... */]);

Updates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. You can define a trust anchor as a reference to an Private Certificate Authority (Private CA) or by uploading a CA certificate. Your Amazon Web Services workloads can authenticate with the trust anchor using certificates issued by the CA in exchange for temporary Amazon Web Services credentials.

Required permissions: rolesanywhere:UpdateTrustAnchor.

Parameter Syntax

$result = $client->updateTrustAnchor([
    'name' => '<string>',
    'source' => [
        'sourceData' => [
            'acmPcaArn' => '<string>',
            'x509CertificateData' => '<string>',
        ],
        'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
    ],
    'trustAnchorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'trustAnchor' => [
        'createdAt' => <DateTime>,
        'enabled' => true || false,
        'name' => '<string>',
        'notificationSettings' => [
            [
                'channel' => 'ALL',
                'configuredBy' => '<string>',
                'enabled' => true || false,
                'event' => 'CA_CERTIFICATE_EXPIRY|END_ENTITY_CERTIFICATE_EXPIRY',
                'threshold' => <integer>,
            ],
            // ...
        ],
        'source' => [
            'sourceData' => [
                'acmPcaArn' => '<string>',
                'x509CertificateData' => '<string>',
            ],
            'sourceType' => 'AWS_ACM_PCA|CERTIFICATE_BUNDLE|SELF_SIGNED_REPOSITORY',
        ],
        'trustAnchorArn' => '<string>',
        'trustAnchorId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Validation exception error.

ResourceNotFoundException:

The resource could not be found.

AccessDeniedException:

You do not have sufficient access to perform this action.