Skip to content

AccountAccessClient#

Index > AccountAccess > AccountAccessClient

Auto-generated documentation for AccountAccess type annotations stubs module mypy-boto3-account-access.

AccountAccessClient#

Type annotations and code completion for boto3.client("account-access"). boto3 documentation

# AccountAccessClient usage example

from boto3.session import Session
from mypy_boto3_account_access.client import AccountAccessClient

def get_account-access_client() -> AccountAccessClient:
    return Session().client("account-access")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("account-access")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.AlreadyCreatedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_account_access.client import Exceptions

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

Methods#

can_paginate#

Type annotations and code completion for boto3.client("account-access").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("account-access").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_application#

Creates an account access manager instance and its Amazon Web Services account access application in the associated IAM Identity Center instance.

Type annotations and code completion for boto3.client("account-access").create_application method. boto3 documentation

# create_application method definition

def create_application(
    self,
    *,
    identitySource: IdentitySourceTypeDef,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateApplicationResponseTypeDef:  # (2)
    ...
  1. See IdentitySourceTypeDef
  2. See CreateApplicationResponseTypeDef
# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestTypeDef = {  # (1)
    "identitySource": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationRequestTypeDef

create_entitlement#

Creates an entitlement (assignment) in account access manager.

Type annotations and code completion for boto3.client("account-access").create_entitlement method. boto3 documentation

# create_entitlement method definition

def create_entitlement(
    self,
    *,
    applicationArn: str,
    entitlement: EntitlementTypeDef,  # (1)
) -> CreateEntitlementResponseTypeDef:  # (2)
    ...
  1. See EntitlementTypeDef
  2. See CreateEntitlementResponseTypeDef
# create_entitlement method usage example with argument unpacking

kwargs: CreateEntitlementRequestTypeDef = {  # (1)
    "applicationArn": ...,
    "entitlement": ...,
}

parent.create_entitlement(**kwargs)
  1. See CreateEntitlementRequestTypeDef

delete_application#

Deletes an account access manager application.

Type annotations and code completion for boto3.client("account-access").delete_application method. boto3 documentation

# delete_application method definition

def delete_application(
    self,
    *,
    applicationArn: str,
) -> dict[str, Any]:
    ...
# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestTypeDef = {  # (1)
    "applicationArn": ...,
}

parent.delete_application(**kwargs)
  1. See DeleteApplicationRequestTypeDef

delete_entitlement#

Deletes an entitlement from an account access manager application.

Type annotations and code completion for boto3.client("account-access").delete_entitlement method. boto3 documentation

# delete_entitlement method definition

def delete_entitlement(
    self,
    *,
    applicationArn: str,
    entitlementId: str,
) -> dict[str, Any]:
    ...
# delete_entitlement method usage example with argument unpacking

kwargs: DeleteEntitlementRequestTypeDef = {  # (1)
    "applicationArn": ...,
    "entitlementId": ...,
}

parent.delete_entitlement(**kwargs)
  1. See DeleteEntitlementRequestTypeDef

get_application#

Retrieves details about an account access manager application, including its status, identity source, and tags.

Type annotations and code completion for boto3.client("account-access").get_application method. boto3 documentation

# get_application method definition

def get_application(
    self,
    *,
    applicationArn: str,
) -> GetApplicationResponseTypeDef:  # (1)
    ...
  1. See GetApplicationResponseTypeDef
# get_application method usage example with argument unpacking

kwargs: GetApplicationRequestTypeDef = {  # (1)
    "applicationArn": ...,
}

parent.get_application(**kwargs)
  1. See GetApplicationRequestTypeDef

get_entitlement#

Retrieves details about a specific entitlement for an account access manager application, including the principal, IAM role, and target account.

Type annotations and code completion for boto3.client("account-access").get_entitlement method. boto3 documentation

# get_entitlement method definition

def get_entitlement(
    self,
    *,
    applicationArn: str,
    entitlementId: str,
) -> GetEntitlementResponseTypeDef:  # (1)
    ...
  1. See GetEntitlementResponseTypeDef
# get_entitlement method usage example with argument unpacking

kwargs: GetEntitlementRequestTypeDef = {  # (1)
    "applicationArn": ...,
    "entitlementId": ...,
}

parent.get_entitlement(**kwargs)
  1. See GetEntitlementRequestTypeDef

list_applications#

Lists the account access manager applications in your account.

Type annotations and code completion for boto3.client("account-access").list_applications method. boto3 documentation

# list_applications method definition

def list_applications(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListApplicationsResponseTypeDef:  # (1)
    ...
  1. See ListApplicationsResponseTypeDef
# list_applications method usage example with argument unpacking

kwargs: ListApplicationsRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_applications(**kwargs)
  1. See ListApplicationsRequestTypeDef

list_entitlements#

Lists the entitlements for a specified account access manager application.

Type annotations and code completion for boto3.client("account-access").list_entitlements method. boto3 documentation

# list_entitlements method definition

def list_entitlements(
    self,
    *,
    applicationArn: str,
    filter: EntitlementFilterTypeDef,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListEntitlementsResponseTypeDef:  # (2)
    ...
  1. See EntitlementFilterTypeDef
  2. See ListEntitlementsResponseTypeDef
# list_entitlements method usage example with argument unpacking

kwargs: ListEntitlementsRequestTypeDef = {  # (1)
    "applicationArn": ...,
    "filter": ...,
}

parent.list_entitlements(**kwargs)
  1. See ListEntitlementsRequestTypeDef

list_tags_for_resource#

Lists the tags associated with an account access manager resource.

Type annotations and code completion for boto3.client("account-access").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

tag_resource#

Adds tags to an account access manager resource.

Type annotations and code completion for boto3.client("account-access").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# 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 an account access manager resource.

Type annotations and code completion for boto3.client("account-access").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

get_paginator#

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

get_waiter#

Type annotations and code completion for boto3.client("account-access").get_waiter method with overloads.