RolesAnywhere

import { RolesAnywhere } from "https://aws-api.deno.dev/v0.4/services/rolesanywhere.ts?docs=full";

class RolesAnywhere {

constructor(apiFactory: client.ApiFactory);

async createProfile(params: CreateProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>;

async createTrustAnchor(params: CreateTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>;

async deleteCrl(params: ScalarCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>;

async deleteProfile(params: ScalarProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>;

async deleteTrustAnchor(params: ScalarTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>;

async disableCrl(params: ScalarCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>;

async disableProfile(params: ScalarProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>;

async disableTrustAnchor(params: ScalarTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>;

async enableCrl(params: ScalarCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>;

async enableProfile(params: ScalarProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>;

async enableTrustAnchor(params: ScalarTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>;

async getCrl(params: ScalarCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>;

async getProfile(params: ScalarProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>;

async getSubject(params: ScalarSubjectRequest, opts?: client.RequestOptions): Promise<SubjectDetailResponse>;

async getTrustAnchor(params: ScalarTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>;

async importCrl(params: ImportCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>;

async listCrls(params?: ListRequest, opts?: client.RequestOptions): Promise<ListCrlsResponse>;

async listProfiles(params?: ListRequest, opts?: client.RequestOptions): Promise<ListProfilesResponse>;

async listSubjects(params?: ListRequest, opts?: client.RequestOptions): Promise<ListSubjectsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTrustAnchors(params?: ListRequest, opts?: client.RequestOptions): Promise<ListTrustAnchorsResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateCrl(params: UpdateCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>;

async updateProfile(params: UpdateProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>;

async updateTrustAnchor(params: UpdateTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new RolesAnywhere(apiFactory: client.ApiFactory)

[src]

§Methods

createProfile(params: CreateProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>

[src]

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.

createTrustAnchor(params: CreateTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>

[src]

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.

deleteCrl(params: ScalarCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>

[src]

Deletes a certificate revocation list (CRL).

Required permissions: rolesanywhere:DeleteCrl.

deleteProfile(params: ScalarProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>

[src]

Deletes a profile.

Required permissions: rolesanywhere:DeleteProfile.

deleteTrustAnchor(params: ScalarTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>

[src]

Deletes a trust anchor.

Required permissions: rolesanywhere:DeleteTrustAnchor.

disableCrl(params: ScalarCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>

[src]

Disables a certificate revocation list (CRL).

Required permissions: rolesanywhere:DisableCrl.

disableProfile(params: ScalarProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>

[src]

Disables a profile. When disabled, CreateSession requests with this profile fail.

Required permissions: rolesanywhere:DisableProfile.

disableTrustAnchor(params: ScalarTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>

[src]

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

Required permissions: rolesanywhere:DisableTrustAnchor.

enableCrl(params: ScalarCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>

[src]

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

Required permissions: rolesanywhere:EnableCrl.

enableProfile(params: ScalarProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>

[src]

Enables the roles in a profile to receive session credentials in CreateSession.

Required permissions: rolesanywhere:EnableProfile.

enableTrustAnchor(params: ScalarTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>

[src]

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

Required permissions: rolesanywhere:EnableTrustAnchor.

getCrl(params: ScalarCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>

[src]

Gets a certificate revocation list (CRL).

Required permissions: rolesanywhere:GetCrl.

getProfile(params: ScalarProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>

[src]

Gets a profile.

Required permissions: rolesanywhere:GetProfile.

getSubject(params: ScalarSubjectRequest, opts?: client.RequestOptions): Promise<SubjectDetailResponse>

[src]

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.

getTrustAnchor(params: ScalarTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>

[src]

Gets a trust anchor.

Required permissions: rolesanywhere:GetTrustAnchor.

importCrl(params: ImportCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>

[src]

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.

listCrls(params?: ListRequest, opts?: client.RequestOptions): Promise<ListCrlsResponse>

[src]

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

Required permissions: rolesanywhere:ListCrls.

listProfiles(params?: ListRequest, opts?: client.RequestOptions): Promise<ListProfilesResponse>

[src]

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

Required permissions: rolesanywhere:ListProfiles.

listSubjects(params?: ListRequest, opts?: client.RequestOptions): Promise<ListSubjectsResponse>

[src]

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

Required permissions: rolesanywhere:ListSubjects.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags attached to the resource.

Required permissions: rolesanywhere:ListTagsForResource.

listTrustAnchors(params?: ListRequest, opts?: client.RequestOptions): Promise<ListTrustAnchorsResponse>

[src]

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

Required permissions: rolesanywhere:ListTrustAnchors.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Attaches tags to a resource.

Required permissions: rolesanywhere:TagResource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes tags from the resource.

Required permissions: rolesanywhere:UntagResource.

updateCrl(params: UpdateCrlRequest, opts?: client.RequestOptions): Promise<CrlDetailResponse>

[src]

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.

updateProfile(params: UpdateProfileRequest, opts?: client.RequestOptions): Promise<ProfileDetailResponse>

[src]

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.

updateTrustAnchor(params: UpdateTrustAnchorRequest, opts?: client.RequestOptions): Promise<TrustAnchorDetailResponse>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]