IAMRolesAnywhereClient

Index > IAMRolesAnywhere > IAMRolesAnywhereClient

Auto-generated documentation for IAMRolesAnywhere type annotations stubs module types-boto3-rolesanywhere.

IAMRolesAnywhereClient

Type annotations and code completion for boto3.client("rolesanywhere"). boto3 documentation

# IAMRolesAnywhereClient usage example

from boto3.session import Session
from types_boto3_rolesanywhere.client import IAMRolesAnywhereClient

def get_rolesanywhere_client() -> IAMRolesAnywhereClient:
    return Session().client("rolesanywhere")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("rolesanywhere").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("rolesanywhere")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.TooManyTagsException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from types_boto3_rolesanywhere.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("rolesanywhere").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("rolesanywhere").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_profile

Creates a profile, a list of the roles that Roles Anywhere service is trusted to assume.

Type annotations and code completion for boto3.client("rolesanywhere").create_profile method. boto3 documentation

# create_profile method definition

def create_profile(
    self,
    *,
    name: str,
    roleArns: Sequence[str],
    acceptRoleSessionName: bool = ...,
    durationSeconds: int = ...,
    enabled: bool = ...,
    managedPolicyArns: Sequence[str] = ...,
    requireInstanceProperties: bool = ...,
    sessionPolicy: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> ProfileDetailResponseTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See ProfileDetailResponseTypeDef

# create_profile method usage example with argument unpacking

kwargs: CreateProfileRequestTypeDef = {  # (1)
    "name": ...,
    "roleArns": ...,
}

parent.create_profile(**kwargs)

1. See CreateProfileRequestTypeDef

create_trust_anchor

Creates a trust anchor to establish trust between IAM Roles Anywhere and your certificate authority (CA).

Type annotations and code completion for boto3.client("rolesanywhere").create_trust_anchor method. boto3 documentation

# create_trust_anchor method definition

def create_trust_anchor(
    self,
    *,
    name: str,
    source: SourceTypeDef,  # (1)
    enabled: bool = ...,
    notificationSettings: Sequence[NotificationSettingTypeDef] = ...,  # (2)
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> TrustAnchorDetailResponseTypeDef:  # (4)
    ...

1. See SourceTypeDef
2. See Sequence[NotificationSettingTypeDef]
3. See Sequence[TagTypeDef]
4. See TrustAnchorDetailResponseTypeDef

# create_trust_anchor method usage example with argument unpacking

kwargs: CreateTrustAnchorRequestTypeDef = {  # (1)
    "name": ...,
    "source": ...,
}

parent.create_trust_anchor(**kwargs)

1. See CreateTrustAnchorRequestTypeDef

delete_attribute_mapping

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

Type annotations and code completion for boto3.client("rolesanywhere").delete_attribute_mapping method. boto3 documentation

# delete_attribute_mapping method definition

def delete_attribute_mapping(
    self,
    *,
    certificateField: CertificateFieldType,  # (1)
    profileId: str,
    specifiers: Sequence[str] = ...,
) -> DeleteAttributeMappingResponseTypeDef:  # (2)
    ...

1. See CertificateFieldType
2. See DeleteAttributeMappingResponseTypeDef

# delete_attribute_mapping method usage example with argument unpacking

kwargs: DeleteAttributeMappingRequestTypeDef = {  # (1)
    "certificateField": ...,
    "profileId": ...,
}

parent.delete_attribute_mapping(**kwargs)

1. See DeleteAttributeMappingRequestTypeDef

delete_crl

Deletes a certificate revocation list (CRL).

Type annotations and code completion for boto3.client("rolesanywhere").delete_crl method. boto3 documentation

# delete_crl method definition

def delete_crl(
    self,
    *,
    crlId: str,
) -> CrlDetailResponseTypeDef:  # (1)
    ...

1. See CrlDetailResponseTypeDef

# delete_crl method usage example with argument unpacking

kwargs: ScalarCrlRequestTypeDef = {  # (1)
    "crlId": ...,
}

parent.delete_crl(**kwargs)

1. See ScalarCrlRequestTypeDef

delete_profile

Deletes a profile.

Type annotations and code completion for boto3.client("rolesanywhere").delete_profile method. boto3 documentation

# delete_profile method definition

def delete_profile(
    self,
    *,
    profileId: str,
) -> ProfileDetailResponseTypeDef:  # (1)
    ...

1. See ProfileDetailResponseTypeDef

# delete_profile method usage example with argument unpacking

kwargs: ScalarProfileRequestTypeDef = {  # (1)
    "profileId": ...,
}

parent.delete_profile(**kwargs)

1. See ScalarProfileRequestTypeDef

delete_trust_anchor

Deletes a trust anchor.

Type annotations and code completion for boto3.client("rolesanywhere").delete_trust_anchor method. boto3 documentation

# delete_trust_anchor method definition

def delete_trust_anchor(
    self,
    *,
    trustAnchorId: str,
) -> TrustAnchorDetailResponseTypeDef:  # (1)
    ...

1. See TrustAnchorDetailResponseTypeDef

# delete_trust_anchor method usage example with argument unpacking

kwargs: ScalarTrustAnchorRequestTypeDef = {  # (1)
    "trustAnchorId": ...,
}

parent.delete_trust_anchor(**kwargs)

1. See ScalarTrustAnchorRequestTypeDef

disable_crl

Disables a certificate revocation list (CRL).

Type annotations and code completion for boto3.client("rolesanywhere").disable_crl method. boto3 documentation

# disable_crl method definition

def disable_crl(
    self,
    *,
    crlId: str,
) -> CrlDetailResponseTypeDef:  # (1)
    ...

1. See CrlDetailResponseTypeDef

# disable_crl method usage example with argument unpacking

kwargs: ScalarCrlRequestRequestTypeDef = {  # (1)
    "crlId": ...,
}

parent.disable_crl(**kwargs)

1. See ScalarCrlRequestRequestTypeDef

disable_profile

Disables a profile.

Type annotations and code completion for boto3.client("rolesanywhere").disable_profile method. boto3 documentation

# disable_profile method definition

def disable_profile(
    self,
    *,
    profileId: str,
) -> ProfileDetailResponseTypeDef:  # (1)
    ...

1. See ProfileDetailResponseTypeDef

# disable_profile method usage example with argument unpacking

kwargs: ScalarProfileRequestRequestTypeDef = {  # (1)
    "profileId": ...,
}

parent.disable_profile(**kwargs)

1. See ScalarProfileRequestRequestTypeDef

disable_trust_anchor

Disables a trust anchor.

Type annotations and code completion for boto3.client("rolesanywhere").disable_trust_anchor method. boto3 documentation

# disable_trust_anchor method definition

def disable_trust_anchor(
    self,
    *,
    trustAnchorId: str,
) -> TrustAnchorDetailResponseTypeDef:  # (1)
    ...

1. See TrustAnchorDetailResponseTypeDef

# disable_trust_anchor method usage example with argument unpacking

kwargs: ScalarTrustAnchorRequestRequestTypeDef = {  # (1)
    "trustAnchorId": ...,
}

parent.disable_trust_anchor(**kwargs)

1. See ScalarTrustAnchorRequestRequestTypeDef

enable_crl

Enables a certificate revocation list (CRL).

Type annotations and code completion for boto3.client("rolesanywhere").enable_crl method. boto3 documentation

# enable_crl method definition

def enable_crl(
    self,
    *,
    crlId: str,
) -> CrlDetailResponseTypeDef:  # (1)
    ...

1. See CrlDetailResponseTypeDef

# enable_crl method usage example with argument unpacking

kwargs: ScalarCrlRequestRequestExtraTypeDef = {  # (1)
    "crlId": ...,
}

parent.enable_crl(**kwargs)

1. See ScalarCrlRequestRequestExtraTypeDef

enable_profile

Enables temporary credential requests for a profile.

Type annotations and code completion for boto3.client("rolesanywhere").enable_profile method. boto3 documentation

# enable_profile method definition

def enable_profile(
    self,
    *,
    profileId: str,
) -> ProfileDetailResponseTypeDef:  # (1)
    ...

1. See ProfileDetailResponseTypeDef

# enable_profile method usage example with argument unpacking

kwargs: ScalarProfileRequestRequestExtraTypeDef = {  # (1)
    "profileId": ...,
}

parent.enable_profile(**kwargs)

1. See ScalarProfileRequestRequestExtraTypeDef

enable_trust_anchor

Enables a trust anchor.

Type annotations and code completion for boto3.client("rolesanywhere").enable_trust_anchor method. boto3 documentation

# enable_trust_anchor method definition

def enable_trust_anchor(
    self,
    *,
    trustAnchorId: str,
) -> TrustAnchorDetailResponseTypeDef:  # (1)
    ...

1. See TrustAnchorDetailResponseTypeDef

# enable_trust_anchor method usage example with argument unpacking

kwargs: ScalarTrustAnchorRequestRequestExtraTypeDef = {  # (1)
    "trustAnchorId": ...,
}

parent.enable_trust_anchor(**kwargs)

1. See ScalarTrustAnchorRequestRequestExtraTypeDef

get_crl

Gets a certificate revocation list (CRL).

Type annotations and code completion for boto3.client("rolesanywhere").get_crl method. boto3 documentation

# get_crl method definition

def get_crl(
    self,
    *,
    crlId: str,
) -> CrlDetailResponseTypeDef:  # (1)
    ...

1. See CrlDetailResponseTypeDef

# get_crl method usage example with argument unpacking

kwargs: ScalarCrlRequestRequestExtraExtraTypeDef = {  # (1)
    "crlId": ...,
}

parent.get_crl(**kwargs)

1. See ScalarCrlRequestRequestExtraExtraTypeDef

get_profile

Gets a profile.

Type annotations and code completion for boto3.client("rolesanywhere").get_profile method. boto3 documentation

# get_profile method definition

def get_profile(
    self,
    *,
    profileId: str,
) -> ProfileDetailResponseTypeDef:  # (1)
    ...

1. See ProfileDetailResponseTypeDef

# get_profile method usage example with argument unpacking

kwargs: ScalarProfileRequestRequestExtraExtraTypeDef = {  # (1)
    "profileId": ...,
}

parent.get_profile(**kwargs)

1. See ScalarProfileRequestRequestExtraExtraTypeDef

get_subject

Gets a subject, which associates a certificate identity with authentication attempts.

Type annotations and code completion for boto3.client("rolesanywhere").get_subject method. boto3 documentation

# get_subject method definition

def get_subject(
    self,
    *,
    subjectId: str,
) -> SubjectDetailResponseTypeDef:  # (1)
    ...

1. See SubjectDetailResponseTypeDef

# get_subject method usage example with argument unpacking

kwargs: ScalarSubjectRequestTypeDef = {  # (1)
    "subjectId": ...,
}

parent.get_subject(**kwargs)

1. See ScalarSubjectRequestTypeDef

get_trust_anchor

Gets a trust anchor.

Type annotations and code completion for boto3.client("rolesanywhere").get_trust_anchor method. boto3 documentation

# get_trust_anchor method definition

def get_trust_anchor(
    self,
    *,
    trustAnchorId: str,
) -> TrustAnchorDetailResponseTypeDef:  # (1)
    ...

1. See TrustAnchorDetailResponseTypeDef

# get_trust_anchor method usage example with argument unpacking

kwargs: ScalarTrustAnchorRequestRequestExtraExtraTypeDef = {  # (1)
    "trustAnchorId": ...,
}

parent.get_trust_anchor(**kwargs)

1. See ScalarTrustAnchorRequestRequestExtraExtraTypeDef

import_crl

Imports the certificate revocation list (CRL).

Type annotations and code completion for boto3.client("rolesanywhere").import_crl method. boto3 documentation

# import_crl method definition

def import_crl(
    self,
    *,
    crlData: BlobTypeDef,
    name: str,
    trustAnchorArn: str,
    enabled: bool = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CrlDetailResponseTypeDef:  # (2)
    ...

1. See Sequence[TagTypeDef]
2. See CrlDetailResponseTypeDef

# import_crl method usage example with argument unpacking

kwargs: ImportCrlRequestTypeDef = {  # (1)
    "crlData": ...,
    "name": ...,
    "trustAnchorArn": ...,
}

parent.import_crl(**kwargs)

1. See ImportCrlRequestTypeDef

list_crls

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

Type annotations and code completion for boto3.client("rolesanywhere").list_crls method. boto3 documentation

# list_crls method definition

def list_crls(
    self,
    *,
    nextToken: str = ...,
    pageSize: int = ...,
) -> ListCrlsResponseTypeDef:  # (1)
    ...

1. See ListCrlsResponseTypeDef

# list_crls method usage example with argument unpacking

kwargs: ListRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_crls(**kwargs)

1. See ListRequestTypeDef

list_profiles

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

Type annotations and code completion for boto3.client("rolesanywhere").list_profiles method. boto3 documentation

# list_profiles method definition

def list_profiles(
    self,
    *,
    nextToken: str = ...,
    pageSize: int = ...,
) -> ListProfilesResponseTypeDef:  # (1)
    ...

1. See ListProfilesResponseTypeDef

# list_profiles method usage example with argument unpacking

kwargs: ListRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_profiles(**kwargs)

1. See ListRequestRequestTypeDef

list_subjects

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

Type annotations and code completion for boto3.client("rolesanywhere").list_subjects method. boto3 documentation

# list_subjects method definition

def list_subjects(
    self,
    *,
    nextToken: str = ...,
    pageSize: int = ...,
) -> ListSubjectsResponseTypeDef:  # (1)
    ...

1. See ListSubjectsResponseTypeDef

# list_subjects method usage example with argument unpacking

kwargs: ListRequestRequestExtraTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_subjects(**kwargs)

1. See ListRequestRequestExtraTypeDef

list_tags_for_resource

Lists the tags attached to the resource.

Type annotations and code completion for boto3.client("rolesanywhere").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_trust_anchors

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

Type annotations and code completion for boto3.client("rolesanywhere").list_trust_anchors method. boto3 documentation

# list_trust_anchors method definition

def list_trust_anchors(
    self,
    *,
    nextToken: str = ...,
    pageSize: int = ...,
) -> ListTrustAnchorsResponseTypeDef:  # (1)
    ...

1. See ListTrustAnchorsResponseTypeDef

# list_trust_anchors method usage example with argument unpacking

kwargs: ListRequestRequestExtraExtraTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_trust_anchors(**kwargs)

1. See ListRequestRequestExtraExtraTypeDef

put_attribute_mapping

Put an entry in the attribute mapping rules that will be enforced by a given profile.

Type annotations and code completion for boto3.client("rolesanywhere").put_attribute_mapping method. boto3 documentation

# put_attribute_mapping method definition

def put_attribute_mapping(
    self,
    *,
    certificateField: CertificateFieldType,  # (1)
    mappingRules: Sequence[MappingRuleTypeDef],  # (2)
    profileId: str,
) -> PutAttributeMappingResponseTypeDef:  # (3)
    ...

1. See CertificateFieldType
2. See Sequence[MappingRuleTypeDef]
3. See PutAttributeMappingResponseTypeDef

# put_attribute_mapping method usage example with argument unpacking

kwargs: PutAttributeMappingRequestTypeDef = {  # (1)
    "certificateField": ...,
    "mappingRules": ...,
    "profileId": ...,
}

parent.put_attribute_mapping(**kwargs)

1. See PutAttributeMappingRequestTypeDef

put_notification_settings

Attaches a list of notification settings to a trust anchor.

Type annotations and code completion for boto3.client("rolesanywhere").put_notification_settings method. boto3 documentation

# put_notification_settings method definition

def put_notification_settings(
    self,
    *,
    notificationSettings: Sequence[NotificationSettingTypeDef],  # (1)
    trustAnchorId: str,
) -> PutNotificationSettingsResponseTypeDef:  # (2)
    ...

1. See Sequence[NotificationSettingTypeDef]
2. See PutNotificationSettingsResponseTypeDef

# put_notification_settings method usage example with argument unpacking

kwargs: PutNotificationSettingsRequestTypeDef = {  # (1)
    "notificationSettings": ...,
    "trustAnchorId": ...,
}

parent.put_notification_settings(**kwargs)

1. See PutNotificationSettingsRequestTypeDef

reset_notification_settings

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

Type annotations and code completion for boto3.client("rolesanywhere").reset_notification_settings method. boto3 documentation

# reset_notification_settings method definition

def reset_notification_settings(
    self,
    *,
    notificationSettingKeys: Sequence[NotificationSettingKeyTypeDef],  # (1)
    trustAnchorId: str,
) -> ResetNotificationSettingsResponseTypeDef:  # (2)
    ...

1. See Sequence[NotificationSettingKeyTypeDef]
2. See ResetNotificationSettingsResponseTypeDef

# reset_notification_settings method usage example with argument unpacking

kwargs: ResetNotificationSettingsRequestTypeDef = {  # (1)
    "notificationSettingKeys": ...,
    "trustAnchorId": ...,
}

parent.reset_notification_settings(**kwargs)

1. See ResetNotificationSettingsRequestTypeDef

tag_resource

Attaches tags to a resource.

Type annotations and code completion for boto3.client("rolesanywhere").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See Sequence[TagTypeDef]

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes tags from the resource.

Type annotations and code completion for boto3.client("rolesanywhere").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_crl

Updates the certificate revocation list (CRL).

Type annotations and code completion for boto3.client("rolesanywhere").update_crl method. boto3 documentation

# update_crl method definition

def update_crl(
    self,
    *,
    crlId: str,
    crlData: BlobTypeDef = ...,
    name: str = ...,
) -> CrlDetailResponseTypeDef:  # (1)
    ...

1. See CrlDetailResponseTypeDef

# update_crl method usage example with argument unpacking

kwargs: UpdateCrlRequestTypeDef = {  # (1)
    "crlId": ...,
}

parent.update_crl(**kwargs)

1. See UpdateCrlRequestTypeDef

update_profile

Updates a profile, a list of the roles that IAM Roles Anywhere service is trusted to assume.

Type annotations and code completion for boto3.client("rolesanywhere").update_profile method. boto3 documentation

# update_profile method definition

def update_profile(
    self,
    *,
    profileId: str,
    acceptRoleSessionName: bool = ...,
    durationSeconds: int = ...,
    managedPolicyArns: Sequence[str] = ...,
    name: str = ...,
    roleArns: Sequence[str] = ...,
    sessionPolicy: str = ...,
) -> ProfileDetailResponseTypeDef:  # (1)
    ...

1. See ProfileDetailResponseTypeDef

# update_profile method usage example with argument unpacking

kwargs: UpdateProfileRequestTypeDef = {  # (1)
    "profileId": ...,
}

parent.update_profile(**kwargs)

1. See UpdateProfileRequestTypeDef

update_trust_anchor

Updates a trust anchor.

Type annotations and code completion for boto3.client("rolesanywhere").update_trust_anchor method. boto3 documentation

# update_trust_anchor method definition

def update_trust_anchor(
    self,
    *,
    trustAnchorId: str,
    name: str = ...,
    source: SourceTypeDef = ...,  # (1)
) -> TrustAnchorDetailResponseTypeDef:  # (2)
    ...

1. See SourceTypeDef
2. See TrustAnchorDetailResponseTypeDef

# update_trust_anchor method usage example with argument unpacking

kwargs: UpdateTrustAnchorRequestTypeDef = {  # (1)
    "trustAnchorId": ...,
}

parent.update_trust_anchor(**kwargs)

1. See UpdateTrustAnchorRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("rolesanywhere").get_paginator method with overloads.

• client.get_paginator("list_crls") -> ListCrlsPaginator
• client.get_paginator("list_profiles") -> ListProfilesPaginator
• client.get_paginator("list_subjects") -> ListSubjectsPaginator
• client.get_paginator("list_trust_anchors") -> ListTrustAnchorsPaginator