AWS Identity and Access Management Roles Anywhere provides a secure way for your workloads such as servers, containers, and applications running outside of AWS to obtain Temporary AWS credentials. Your workloads can use the same IAM policies and roles that you have configured with native AWS applications to access AWS resources. Using IAM Roles Anywhere will eliminate the need to manage long term credentials for workloads running outside of AWS.
To use IAM Roles Anywhere customer workloads will need to use X.509 certificates issued by their Certificate Authority (CA) . The Certificate Authority (CA) needs to be registered with IAM Roles Anywhere as a trust anchor to establish trust between customer PKI and IAM Roles Anywhere. Customers who do not manage their own PKI system can use AWS Certificate Manager Private Certificate Authority (ACM PCA) to create a Certificate Authority and use that to establish trust with IAM Roles Anywhere
This guide describes the IAM rolesanywhere operations that you can call programmatically. For general information about IAM Roles Anywhere see https://docs.aws.amazon.com/
", "operations": { "CreateProfile": "Creates a profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can intersect permissions with IAM managed policies.
Required permissions: rolesanywhere:CreateProfile.
Creates a trust anchor. You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.
Required permissions: rolesanywhere:CreateTrustAnchor.
Deletes a certificate revocation list (CRL).
Required permissions: rolesanywhere:DeleteCrl.
Deletes a profile.
Required permissions: rolesanywhere:DeleteProfile.
Deletes a trust anchor.
Required permissions: rolesanywhere:DeleteTrustAnchor.
Disables a certificate revocation list (CRL).
Required permissions: rolesanywhere:DisableCrl.
Disables a profile. When disabled, CreateSession requests with this profile fail.
Required permissions: rolesanywhere:DisableProfile.
Disables a trust anchor. When disabled, CreateSession requests specifying this trust anchor are unauthorized.
Required permissions: rolesanywhere:DisableTrustAnchor.
Enables a certificate revocation list (CRL). When enabled, certificates stored in the CRL are unauthorized to receive session credentials.
Required permissions: rolesanywhere:EnableCrl.
Enables the roles in a profile to receive session credentials in CreateSession.
Required permissions: rolesanywhere:EnableProfile.
Enables a trust anchor. When enabled, certificates in the trust anchor chain are authorized for trust validation.
Required permissions: rolesanywhere:EnableTrustAnchor.
Gets a certificate revocation list (CRL).
Required permissions: rolesanywhere:GetCrl.
Gets a profile.
Required permissions: rolesanywhere:GetProfile.
Gets a Subject. A Subject associates a certificate identity with authentication attempts by CreateSession. The Subject resources stores audit information such as status of the last authentication attempt, the certificate data used in the attempt, and the last time the associated identity attempted authentication.
Required permissions: rolesanywhere:GetSubject.
Gets a trust anchor.
Required permissions: rolesanywhere:GetTrustAnchor.
Imports the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.
Required permissions: rolesanywhere:ImportCrl.
Lists all Crls in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListCrls.
Lists all profiles in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListProfiles.
Lists the subjects in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListSubjects.
Lists the tags attached to the resource.
Required permissions: rolesanywhere:ListTagsForResource.
Lists the trust anchors in the authenticated account and Amazon Web Services Region.
Required permissions: rolesanywhere:ListTrustAnchors.
Attaches tags to a resource.
Required permissions: rolesanywhere:TagResource.
Removes tags from the resource.
Required permissions: rolesanywhere:UntagResource.
Updates the certificate revocation list (CRL). CRl is a list of certificates that have been revoked by the issuing certificate Authority (CA). IAM Roles Anywhere validates against the crl list before issuing credentials.
Required permissions: rolesanywhere:UpdateCrl.
Updates the profile. A profile is configuration resource to list the roles that RolesAnywhere service is trusted to assume. In addition, by applying a profile you can scope-down permissions with IAM managed policies.
Required permissions: rolesanywhere:UpdateProfile.
Updates the trust anchor.You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor. A Trust Anchor is defined either as a reference to a AWS Certificate Manager Private Certificate Authority (ACM PCA), or by uploading a Certificate Authority (CA) certificate. Your AWS workloads can authenticate with the trust anchor using certificates issued by the trusted Certificate Authority (CA) in exchange for temporary AWS credentials.
Required permissions: rolesanywhere:UpdateTrustAnchor.
You do not have sufficient access to perform this action.
", "refs": { } }, "AmazonResourceName": { "base": null, "refs": { "ListTagsForResourceRequest$resourceArn": "The ARN of the resource.
", "TagResourceRequest$resourceArn": "The ARN of the resource.
", "UntagResourceRequest$resourceArn": "The ARN of the resource.
" } }, "Blob": { "base": null, "refs": { "CrlDetail$crlData": "The state of the certificate revocation list (CRL) after a read or write operation.
" } }, "Boolean": { "base": null, "refs": { "CreateProfileRequest$enabled": "Specifies whether the profile is enabled.
", "CreateProfileRequest$requireInstanceProperties": "Specifies whether instance properties are required in CreateSession requests with this profile.
", "CreateTrustAnchorRequest$enabled": "Specifies whether the trust anchor is enabled.
", "CredentialSummary$enabled": "Indicates whether the credential is enabled.
", "CredentialSummary$failed": "Indicates whether the CreateSession operation was successful.
", "CrlDetail$enabled": "Indicates whether the certificate revocation list (CRL) is enabled.
", "ImportCrlRequest$enabled": "Specifies whether the certificate revocation list (CRL) is enabled.
", "InstanceProperty$failed": "Indicates whether the CreateSession operation was successful.
", "ProfileDetail$enabled": "Indicates whether the profile is enabled.
", "ProfileDetail$requireInstanceProperties": "Specifies whether instance properties are required in CreateSession requests with this profile.
", "SubjectDetail$enabled": "The enabled status of the subject.
", "SubjectSummary$enabled": "The enabled status of the Subject.
", "TrustAnchorDetail$enabled": "Indicates whether the trust anchor is enabled.
" } }, "CreateProfileRequest": { "base": null, "refs": { } }, "CreateProfileRequestDurationSecondsInteger": { "base": null, "refs": { "CreateProfileRequest$durationSeconds": "The number of seconds the vended session credentials are valid for.
" } }, "CreateTrustAnchorRequest": { "base": null, "refs": { } }, "CredentialSummaries": { "base": null, "refs": { "SubjectDetail$credentials": "The temporary session credentials vended at the last authenticating call with this Subject.
" } }, "CredentialSummary": { "base": "A record of a presented X509 credential to CreateSession.
", "refs": { "CredentialSummaries$member": null } }, "CrlDetail": { "base": "The state of the certificate revocation list (CRL) after a read or write operation.
", "refs": { "CrlDetailResponse$crl": "The state of the certificate revocation list (CRL) after a read or write operation.
", "CrlDetails$member": null } }, "CrlDetailResponse": { "base": null, "refs": { } }, "CrlDetails": { "base": null, "refs": { "ListCrlsResponse$crls": "A list of certificate revocation lists (CRL).
" } }, "ImportCrlRequest": { "base": null, "refs": { } }, "ImportCrlRequestCrlDataBlob": { "base": null, "refs": { "ImportCrlRequest$crlData": "The x509 v3 specified certificate revocation list
" } }, "InstanceProperties": { "base": null, "refs": { "SubjectDetail$instanceProperties": "The specified instance properties associated with the request.
" } }, "InstanceProperty": { "base": "A key-value pair you set that identifies a property of the authenticating instance.
", "refs": { "InstanceProperties$member": null } }, "InstancePropertyMap": { "base": null, "refs": { "InstanceProperty$properties": "A list of instanceProperty objects.
" } }, "InstancePropertyMapKeyString": { "base": null, "refs": { "InstancePropertyMap$key": null } }, "InstancePropertyMapValueString": { "base": null, "refs": { "InstancePropertyMap$value": null } }, "Integer": { "base": null, "refs": { "ListRequest$pageSize": "The number of resources in the paginated list.
", "ProfileDetail$durationSeconds": "The number of seconds the vended session credentials are valid for.
" } }, "ListCrlsResponse": { "base": null, "refs": { } }, "ListProfilesResponse": { "base": null, "refs": { } }, "ListRequest": { "base": null, "refs": { } }, "ListRequestNextTokenString": { "base": null, "refs": { "ListRequest$nextToken": "A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.
" } }, "ListSubjectsResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "ListTrustAnchorsResponse": { "base": null, "refs": { } }, "ManagedPolicyList": { "base": null, "refs": { "CreateProfileRequest$managedPolicyArns": "A list of managed policy ARNs that apply to the vended session credentials.
", "ProfileDetail$managedPolicyArns": "A list of managed policy ARNs that apply to the vended session credentials.
", "UpdateProfileRequest$managedPolicyArns": "A list of managed policy ARNs that apply to the vended session credentials.
" } }, "ManagedPolicyListMemberString": { "base": null, "refs": { "ManagedPolicyList$member": null } }, "ProfileArn": { "base": null, "refs": { "ProfileDetail$profileArn": "The ARN of the profile.
" } }, "ProfileDetail": { "base": "The state of the profile after a read or write operation.
", "refs": { "ProfileDetailResponse$profile": "The state of the profile after a read or write operation.
", "ProfileDetails$member": null } }, "ProfileDetailResponse": { "base": null, "refs": { } }, "ProfileDetails": { "base": null, "refs": { "ListProfilesResponse$profiles": "A list of profiles.
" } }, "ResourceName": { "base": null, "refs": { "CreateProfileRequest$name": "The name of the profile.
", "CreateTrustAnchorRequest$name": "The name of the trust anchor.
", "ImportCrlRequest$name": "The name of the certificate revocation list (CRL).
", "ProfileDetail$name": "The name of the profile.
", "TrustAnchorDetail$name": "The name of the trust anchor.
", "UpdateCrlRequest$name": "The name of the Crl.
", "UpdateProfileRequest$name": "The name of the profile.
", "UpdateTrustAnchorRequest$name": "The name of the trust anchor.
" } }, "ResourceNotFoundException": { "base": "The resource could not be found.
", "refs": { } }, "RoleArn": { "base": null, "refs": { "RoleArnList$member": null } }, "RoleArnList": { "base": null, "refs": { "CreateProfileRequest$roleArns": "A list of IAM roles that this profile can assume in a CreateSession operation.
", "ProfileDetail$roleArns": "A list of IAM roles that this profile can assume in a CreateSession operation.
", "UpdateProfileRequest$roleArns": "A list of IAM roles that this profile can assume in a CreateSession operation.
" } }, "ScalarCrlRequest": { "base": null, "refs": { } }, "ScalarProfileRequest": { "base": null, "refs": { } }, "ScalarSubjectRequest": { "base": null, "refs": { } }, "ScalarTrustAnchorRequest": { "base": null, "refs": { } }, "Source": { "base": "The trust anchor type and its related certificate data.
", "refs": { "CreateTrustAnchorRequest$source": "The trust anchor type and its related certificate data.
", "TrustAnchorDetail$source": "The trust anchor type and its related certificate data.
", "UpdateTrustAnchorRequest$source": "The trust anchor type and its related certificate data.
" } }, "SourceData": { "base": "The data field of the trust anchor depending on its type.
", "refs": { "Source$sourceData": "The data field of the trust anchor depending on its type.
" } }, "String": { "base": null, "refs": { "AccessDeniedException$message": null, "CreateProfileRequest$sessionPolicy": "A session policy that applies to the trust boundary of the vended session credentials.
", "CredentialSummary$issuer": "The fully qualified domain name of the issuing certificate for the presented end-entity certificate.
", "CredentialSummary$serialNumber": "The serial number of the certificate.
", "CredentialSummary$x509CertificateData": "The PEM-encoded data of the certificate.
", "CrlDetail$crlArn": "The ARN of the certificate revocation list (CRL).
", "CrlDetail$name": "The name of the certificate revocation list (CRL).
", "CrlDetail$trustAnchorArn": "The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.
", "ListCrlsResponse$nextToken": "A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.
", "ListProfilesResponse$nextToken": "A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.
", "ListSubjectsResponse$nextToken": "A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.
", "ListTrustAnchorsResponse$nextToken": "A token that indicates where the output should continue from, if a previous operation did not show all results. To get the next results, call the operation again with this value.
", "ProfileDetail$createdBy": "The Amazon Web Services account that created the profile.
", "ProfileDetail$sessionPolicy": "A session policy that applies to the trust boundary of the vended session credentials.
", "ResourceNotFoundException$message": null, "SourceData$acmPcaArn": "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.
The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE.
The ARN of the resource.
", "SubjectDetail$x509Subject": "The x509 principal identifier of the authenticating certificate.
", "SubjectSummary$subjectArn": "The ARN of the resource.
", "SubjectSummary$x509Subject": "The x509 principal identifier of the authenticating certificate.
", "TooManyTagsException$message": null, "TrustAnchorDetail$trustAnchorArn": "The ARN of the trust anchor.
", "ValidationException$message": null } }, "SubjectDetail": { "base": "The state of the subject after a read or write operation.
", "refs": { "SubjectDetailResponse$subject": "The state of the subject after a read or write operation.
" } }, "SubjectDetailResponse": { "base": null, "refs": { } }, "SubjectSummaries": { "base": null, "refs": { "ListSubjectsResponse$subjects": "A list of subjects.
" } }, "SubjectSummary": { "base": "A summary representation of Subject resources returned in read operations; primarily ListSubjects.
", "refs": { "SubjectSummaries$member": null } }, "SyntheticTimestamp_date_time": { "base": null, "refs": { "CredentialSummary$seenAt": "The ISO-8601 time stamp of when the certificate was last used in a CreateSession operation.
", "CrlDetail$createdAt": "The ISO-8601 timestamp when the certificate revocation list (CRL) was created.
", "CrlDetail$updatedAt": "The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated.
", "InstanceProperty$seenAt": "The ISO-8601 time stamp of when the certificate was last used in a CreateSession operation.
", "ProfileDetail$createdAt": "The ISO-8601 timestamp when the profile was created.
", "ProfileDetail$updatedAt": "The ISO-8601 timestamp when the profile was last updated.
", "SubjectDetail$createdAt": "The ISO-8601 timestamp when the subject was created.
", "SubjectDetail$lastSeenAt": "The ISO-8601 timestamp of the last time this Subject requested temporary session credentials.
", "SubjectDetail$updatedAt": "The ISO-8601 timestamp when the subject was last updated.
", "SubjectSummary$createdAt": "The ISO-8601 time stamp of when the certificate was first used in a CreateSession operation.
", "SubjectSummary$lastSeenAt": "The ISO-8601 time stamp of when the certificate was last used in a CreateSession operation.
", "SubjectSummary$updatedAt": "The ISO-8601 timestamp when the subject was last updated.
", "TrustAnchorDetail$createdAt": "The ISO-8601 timestamp when the trust anchor was created.
", "TrustAnchorDetail$updatedAt": "The ISO-8601 timestamp when the trust anchor was last updated.
" } }, "Tag": { "base": "A label that consists of a key and value you define.
", "refs": { "TagList$member": null } }, "TagKey": { "base": null, "refs": { "Tag$key": "The tag key.
", "TagKeyList$member": null } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$tagKeys": "A list of keys. Tag keys are the unique identifiers of tags.
" } }, "TagList": { "base": null, "refs": { "CreateProfileRequest$tags": "The tags to attach to the profile.
", "CreateTrustAnchorRequest$tags": "The tags to attach to the trust anchor.
", "ImportCrlRequest$tags": "A list of tags to attach to the certificate revocation list (CRL).
", "ListTagsForResourceResponse$tags": "A list of tags attached to the resource.
", "TagResourceRequest$tags": "The tags to attach to the resource.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "TagValue": { "base": null, "refs": { "Tag$value": "The tag value.
" } }, "TooManyTagsException": { "base": "Too many tags.
", "refs": { } }, "TrustAnchorArn": { "base": null, "refs": { "ImportCrlRequest$trustAnchorArn": "The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for.
" } }, "TrustAnchorDetail": { "base": "The state of the trust anchor after a read or write operation.
", "refs": { "TrustAnchorDetailResponse$trustAnchor": "The state of the trust anchor after a read or write operation.
", "TrustAnchorDetails$member": null } }, "TrustAnchorDetailResponse": { "base": null, "refs": { } }, "TrustAnchorDetails": { "base": null, "refs": { "ListTrustAnchorsResponse$trustAnchors": "A list of trust anchors.
" } }, "TrustAnchorType": { "base": null, "refs": { "Source$sourceType": "The type of the trust anchor.
" } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateCrlRequest": { "base": null, "refs": { } }, "UpdateCrlRequestCrlDataBlob": { "base": null, "refs": { "UpdateCrlRequest$crlData": "The x509 v3 specified certificate revocation list
" } }, "UpdateProfileRequest": { "base": null, "refs": { } }, "UpdateProfileRequestDurationSecondsInteger": { "base": null, "refs": { "UpdateProfileRequest$durationSeconds": "The number of seconds the vended session credentials are valid for.
" } }, "UpdateProfileRequestSessionPolicyString": { "base": null, "refs": { "UpdateProfileRequest$sessionPolicy": "A session policy that applies to the trust boundary of the vended session credentials.
" } }, "UpdateTrustAnchorRequest": { "base": null, "refs": { } }, "Uuid": { "base": null, "refs": { "CrlDetail$crlId": "The unique identifier of the certificate revocation list (CRL).
", "ProfileDetail$profileId": "The unique identifier of the profile.
", "ScalarCrlRequest$crlId": "The unique identifier of the certificate revocation list (CRL).
", "ScalarProfileRequest$profileId": "The unique identifier of the profile.
", "ScalarSubjectRequest$subjectId": "The unique identifier of the subject.
", "ScalarTrustAnchorRequest$trustAnchorId": "The unique identifier of the trust anchor.
", "SubjectDetail$subjectId": "The id of the resource
", "SubjectSummary$subjectId": "The id of the resource.
", "TrustAnchorDetail$trustAnchorId": "The unique identifier of the trust anchor.
", "UpdateCrlRequest$crlId": "The unique identifier of the certificate revocation list (CRL).
", "UpdateProfileRequest$profileId": "The unique identifier of the profile.
", "UpdateTrustAnchorRequest$trustAnchorId": "The unique identifier of the trust anchor.
" } }, "ValidationException": { "base": "Validation exception error.
", "refs": { } } } }