Skip to content

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

# IAMRolesAnywhereClient 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.

# 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 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

# can_paginate 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

# close method definition

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

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],
    durationSeconds: int = ...,
    enabled: bool = ...,
    managedPolicyArns: Sequence[str] = ...,
    requireInstanceProperties: bool = ...,
    sessionPolicy: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> ProfileDetailResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See ProfileDetailResponseTypeDef
# create_profile method usage example with argument unpacking

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

parent.create_profile(**kwargs)
  1. See CreateProfileRequestRequestTypeDef

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 NotificationSettingTypeDef
  3. See TagTypeDef
  4. See TrustAnchorDetailResponseTypeDef
# create_trust_anchor method usage example with argument unpacking

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

parent.create_trust_anchor(**kwargs)
  1. See CreateTrustAnchorRequestRequestTypeDef

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: DeleteAttributeMappingRequestRequestTypeDef = {  # (1)
    "certificateField": ...,
    "profileId": ...,
}

parent.delete_attribute_mapping(**kwargs)
  1. See DeleteAttributeMappingRequestRequestTypeDef

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: 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

# delete_profile method definition

def delete_profile(
    self,
    *,
    profileId: str,
) -> ProfileDetailResponseTypeDef:  # (1)
    ...
  1. See ProfileDetailResponseTypeDef
# delete_profile method usage example with argument unpacking

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

# 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: 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

# 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: ScalarCrlRequestRequestTypeDef = {  # (1)
    "crlId": ...,
}

parent.enable_crl(**kwargs)
  1. See ScalarCrlRequestRequestTypeDef

enable_profile#

Enables temporary credential requests for a profile.

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