Skip to content

SupportAuthZClient#

Index > SupportAuthZ > SupportAuthZClient

Auto-generated documentation for SupportAuthZ type annotations stubs module types-boto3-supportauthz.

SupportAuthZClient#

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

# SupportAuthZClient usage example

from boto3.session import Session
from types_boto3_supportauthz.client import SupportAuthZClient

def get_supportauthz_client() -> SupportAuthZClient:
    return Session().client("supportauthz")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("supportauthz")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    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 types_boto3_supportauthz.client import Exceptions

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

Methods#

can_paginate#

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

Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources.

Type annotations and code completion for boto3.client("supportauthz").create_support_permit method. boto3 documentation

# create_support_permit method definition

def create_support_permit(
    self,
    *,
    permit: PermitUnionTypeDef,  # (1)
    name: str,
    signingKeyInfo: SigningKeyInfoTypeDef,  # (2)
    description: str = ...,
    supportCaseDisplayId: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateSupportPermitOutputTypeDef:  # (3)
    ...
  1. See PermitUnionTypeDef
  2. See SigningKeyInfoTypeDef
  3. See CreateSupportPermitOutputTypeDef
# create_support_permit method usage example with argument unpacking

kwargs: CreateSupportPermitInputTypeDef = {  # (1)
    "permit": ...,
    "name": ...,
    "signingKeyInfo": ...,
}

parent.create_support_permit(**kwargs)
  1. See CreateSupportPermitInputTypeDef

delete_support_permit#

Deletes a support permit, revoking the authorization previously granted to the AWS support operator.

Type annotations and code completion for boto3.client("supportauthz").delete_support_permit method. boto3 documentation

# delete_support_permit method definition

def delete_support_permit(
    self,
    *,
    supportPermitIdentifier: str,
) -> DeleteSupportPermitOutputTypeDef:  # (1)
    ...
  1. See DeleteSupportPermitOutputTypeDef
# delete_support_permit method usage example with argument unpacking

kwargs: DeleteSupportPermitInputTypeDef = {  # (1)
    "supportPermitIdentifier": ...,
}

parent.delete_support_permit(**kwargs)
  1. See DeleteSupportPermitInputTypeDef

get_action#

Retrieves the description of a specific support action.

Type annotations and code completion for boto3.client("supportauthz").get_action method. boto3 documentation

# get_action method definition

def get_action(
    self,
    *,
    action: str,
) -> GetActionOutputTypeDef:  # (1)
    ...
  1. See GetActionOutputTypeDef
# get_action method usage example with argument unpacking

kwargs: GetActionInputTypeDef = {  # (1)
    "action": ...,
}

parent.get_action(**kwargs)
  1. See GetActionInputTypeDef

get_support_permit#

Retrieves the details of a support permit by its ARN or name.

Type annotations and code completion for boto3.client("supportauthz").get_support_permit method. boto3 documentation

# get_support_permit method definition

def get_support_permit(
    self,
    *,
    supportPermitIdentifier: str,
) -> GetSupportPermitOutputTypeDef:  # (1)
    ...
  1. See GetSupportPermitOutputTypeDef
# get_support_permit method usage example with argument unpacking

kwargs: GetSupportPermitInputTypeDef = {  # (1)
    "supportPermitIdentifier": ...,
}

parent.get_support_permit(**kwargs)
  1. See GetSupportPermitInputTypeDef

list_actions#

Lists available support actions for a specified AWS service.

Type annotations and code completion for boto3.client("supportauthz").list_actions method. boto3 documentation

# list_actions method definition

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

kwargs: ListActionsInputTypeDef = {  # (1)
    "service": ...,
}

parent.list_actions(**kwargs)
  1. See ListActionsInputTypeDef

list_support_permit_requests#

Lists permit requests from AWS support operators.

Type annotations and code completion for boto3.client("supportauthz").list_support_permit_requests method. boto3 documentation

# list_support_permit_requests method definition

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

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

parent.list_support_permit_requests(**kwargs)
  1. See ListSupportPermitRequestsInputTypeDef

list_support_permits#

Lists all support permits in the caller's account.

Type annotations and code completion for boto3.client("supportauthz").list_support_permits method. boto3 documentation

# list_support_permits method definition

def list_support_permits(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    supportPermitStatuses: Sequence[SupportPermitStatusType] = ...,  # (1)
) -> ListSupportPermitsOutputTypeDef:  # (2)
    ...
  1. See Sequence[SupportPermitStatusType]
  2. See ListSupportPermitsOutputTypeDef
# list_support_permits method usage example with argument unpacking

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

parent.list_support_permits(**kwargs)
  1. See ListSupportPermitsInputTypeDef

list_tags_for_resource#

Lists the tags associated with a support permit resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef
# list_tags_for_resource method usage example with argument unpacking

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

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputTypeDef

reject_support_permit_request#

Rejects a permit request from an AWS support operator.

Type annotations and code completion for boto3.client("supportauthz").reject_support_permit_request method. boto3 documentation

# reject_support_permit_request method definition

def reject_support_permit_request(
    self,
    *,
    requestArn: str,
) -> RejectSupportPermitRequestOutputTypeDef:  # (1)
    ...
  1. See RejectSupportPermitRequestOutputTypeDef
# reject_support_permit_request method usage example with argument unpacking

kwargs: RejectSupportPermitRequestInputTypeDef = {  # (1)
    "requestArn": ...,
}

parent.reject_support_permit_request(**kwargs)
  1. See RejectSupportPermitRequestInputTypeDef

tag_resource#

Adds or overwrites one or more tags for a support permit resource.

Type annotations and code completion for boto3.client("supportauthz").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: TagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputTypeDef

untag_resource#

Removes one or more tags from a support permit resource.

Type annotations and code completion for boto3.client("supportauthz").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: UntagResourceInputTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputTypeDef

get_paginator#

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