IAMRolesAnywhereClient

Index > IAMRolesAnywhere > IAMRolesAnywhereClient

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

IAMRolesAnywhereClient

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

Usage example

from boto3.session import Session
from mypy_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.

Usage example

client = boto3.client("rolesanywhere")

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

Type checking example

from mypy_boto3_rolesanywhere.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

def close(
    self,
) -> None:
    ...

create_profile

Creates a profile.

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

Method definition

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

1. See TagTypeDef
2. See ProfileDetailResponseTypeDef

Usage example with kwargs

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

parent.create_profile(**kwargs)

1. See CreateProfileRequestRequestTypeDef

create_trust_anchor

Creates a trust anchor.

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

Method definition

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

1. See SourceTypeDef
2. See TagTypeDef
3. See TrustAnchorDetailResponseTypeDef

Usage example with kwargs

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

parent.create_trust_anchor(**kwargs)

1. See CreateTrustAnchorRequestRequestTypeDef

delete_crl

Deletes a certificate revocation list (CRL).

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

Method definition

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

1. See CrlDetailResponseTypeDef

Usage example with kwargs

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

parent.delete_crl(**kwargs)

1. See ScalarCrlRequestRequestTypeDef

delete_profile

Deletes a profile.

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

Method definition

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

1. See ProfileDetailResponseTypeDef

Usage example with kwargs

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

parent.delete_profile(**kwargs)

1. See ScalarProfileRequestRequestTypeDef

delete_trust_anchor

Deletes a trust anchor.

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

Method definition

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

1. See TrustAnchorDetailResponseTypeDef

Usage example with kwargs

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

parent.delete_trust_anchor(**kwargs)

1. See ScalarTrustAnchorRequestRequestTypeDef

disable_crl

Disables a certificate revocation list (CRL).

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

Method definition

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

1. See CrlDetailResponseTypeDef

Usage example with kwargs

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

Method definition

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

1. See ProfileDetailResponseTypeDef

Usage example with kwargs

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

Method definition

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

1. See TrustAnchorDetailResponseTypeDef

Usage example with kwargs

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

Method definition

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

1. See CrlDetailResponseTypeDef

Usage example with kwargs

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

parent.enable_crl(**kwargs)

1. See ScalarCrlRequestRequestTypeDef

enable_profile

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

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

Method definition

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

1. See ProfileDetailResponseTypeDef

Usage example with kwargs

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

parent.enable_profile(**kwargs)

1. See ScalarProfileRequestRequestTypeDef

enable_trust_anchor

Enables a trust anchor.

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

Method definition

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

1. See TrustAnchorDetailResponseTypeDef

Usage example with kwargs

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

parent.enable_trust_anchor(**kwargs)

1. See ScalarTrustAnchorRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

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

get_crl

Gets a certificate revocation list (CRL).

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

Method definition

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

1. See CrlDetailResponseTypeDef

Usage example with kwargs

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

parent.get_crl(**kwargs)

1. See ScalarCrlRequestRequestTypeDef

get_profile

Gets a profile.

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

Method definition

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

1. See ProfileDetailResponseTypeDef

Usage example with kwargs

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

parent.get_profile(**kwargs)

1. See ScalarProfileRequestRequestTypeDef

get_subject

Gets a Subject.

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

Method definition

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

1. See SubjectDetailResponseTypeDef

Usage example with kwargs

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

parent.get_subject(**kwargs)

1. See ScalarSubjectRequestRequestTypeDef

get_trust_anchor

Gets a trust anchor.

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

Method definition

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

1. See TrustAnchorDetailResponseTypeDef

Usage example with kwargs

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

parent.get_trust_anchor(**kwargs)

1. See ScalarTrustAnchorRequestRequestTypeDef

import_crl

Imports the certificate revocation list (CRL).

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

Method definition

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

1. See TagTypeDef
2. See CrlDetailResponseTypeDef

Usage example with kwargs

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

parent.import_crl(**kwargs)

1. See ImportCrlRequestRequestTypeDef

list_crls

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

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

Method definition

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

1. See ListCrlsResponseTypeDef

Usage example with kwargs

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

parent.list_crls(**kwargs)

1. See ListRequestRequestTypeDef

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

Method definition

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

1. See ListProfilesResponseTypeDef

Usage example with kwargs

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

Method definition

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

1. See ListSubjectsResponseTypeDef

Usage example with kwargs

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

parent.list_subjects(**kwargs)

1. See ListRequestRequestTypeDef

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

Method definition

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

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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

Method definition

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

1. See ListTrustAnchorsResponseTypeDef

Usage example with kwargs

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

parent.list_trust_anchors(**kwargs)

1. See ListRequestRequestTypeDef

tag_resource

Attaches tags to a resource.

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

Method definition

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

1. See TagTypeDef

Usage example with kwargs

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from the resource.

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

Method definition

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

Usage example with kwargs

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_crl

Updates the certificate revocation list (CRL).

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

Method definition

def update_crl(
    self,
    *,
    crlId: str,
    crlData: Union[str, bytes, IO[Any], StreamingBody] = ...,
    name: str = ...,
) -> CrlDetailResponseTypeDef:  # (1)
    ...

1. See CrlDetailResponseTypeDef

Usage example with kwargs

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

parent.update_crl(**kwargs)

1. See UpdateCrlRequestRequestTypeDef

update_profile

Updates the profile.

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

Method definition

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

1. See ProfileDetailResponseTypeDef

Usage example with kwargs

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

parent.update_profile(**kwargs)

1. See UpdateProfileRequestRequestTypeDef

update_trust_anchor

Updates the trust anchor.You establish trust between IAM Roles Anywhere and your certificate authority (CA) by configuring a trust anchor.

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

Method definition

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

1. See SourceTypeDef
2. See TrustAnchorDetailResponseTypeDef

Usage example with kwargs

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

parent.update_trust_anchor(**kwargs)

1. See UpdateTrustAnchorRequestRequestTypeDef

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