Skip to content

SupportClient#

Index > Support > SupportClient

Auto-generated documentation for Support type annotations stubs module mypy-boto3-support.

SupportClient#

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

# SupportClient usage example

from boto3.session import Session
from mypy_boto3_support.client import SupportClient

def get_support_client() -> SupportClient:
    return Session().client("support")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("support")

try:
    do_something(client)
except (
    client.exceptions.AttachmentIdNotFound,
    client.exceptions.AttachmentLimitExceeded,
    client.exceptions.AttachmentSetExpired,
    client.exceptions.AttachmentSetIdNotFound,
    client.exceptions.AttachmentSetSizeLimitExceeded,
    client.exceptions.CaseCreationLimitExceeded,
    client.exceptions.CaseIdNotFound,
    client.exceptions.ClientError,
    client.exceptions.DescribeAttachmentLimitExceeded,
    client.exceptions.InternalServerError,
    client.exceptions.ThrottlingException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_support.client import Exceptions

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

Methods#

add_attachments_to_set#

Adds one or more attachments to an attachment set.

Type annotations and code completion for boto3.client("support").add_attachments_to_set method. boto3 documentation

# add_attachments_to_set method definition

def add_attachments_to_set(
    self,
    *,
    attachments: Sequence[AttachmentUnionTypeDef],  # (1)
    attachmentSetId: str = ...,
) -> AddAttachmentsToSetResponseTypeDef:  # (2)
    ...
  1. See AttachmentTypeDef AttachmentOutputTypeDef
  2. See AddAttachmentsToSetResponseTypeDef 
# add_attachments_to_set method usage example with argument unpacking

kwargs: AddAttachmentsToSetRequestRequestTypeDef = {  # (1)
    "attachments": ...,
}

parent.add_attachments_to_set(**kwargs)
  1. See AddAttachmentsToSetRequestRequestTypeDef

add_communication_to_case#

Adds additional customer communication to an Amazon Web Services Support case.

Type annotations and code completion for boto3.client("support").add_communication_to_case method. boto3 documentation

# add_communication_to_case method definition

def add_communication_to_case(
    self,
    *,
    communicationBody: str,
    caseId: str = ...,
    ccEmailAddresses: Sequence[str] = ...,
    attachmentSetId: str = ...,
) -> AddCommunicationToCaseResponseTypeDef:  # (1)
    ...
  1. See AddCommunicationToCaseResponseTypeDef 
# add_communication_to_case method usage example with argument unpacking

kwargs: AddCommunicationToCaseRequestRequestTypeDef = {  # (1)
    "communicationBody": ...,
}

parent.add_communication_to_case(**kwargs)
  1. See AddCommunicationToCaseRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("support").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("support").close method. boto3 documentation

# close method definition

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

create_case#

Creates a case in the Amazon Web Services Support Center.

Type annotations and code completion for boto3.client("support").create_case method. boto3 documentation

# create_case method definition

def create_case(
    self,
    *,
    subject: str,
    communicationBody: str,
    serviceCode: str = ...,
    severityCode: str = ...,
    categoryCode: str = ...,
    ccEmailAddresses: Sequence[str] = ...,
    language: str = ...,
    issueType: str = ...,
    attachmentSetId: str = ...,
) -> CreateCaseResponseTypeDef:  # (1)
    ...
  1. See CreateCaseResponseTypeDef 
# create_case method usage example with argument unpacking

kwargs: CreateCaseRequestRequestTypeDef = {  # (1)
    "subject": ...,
    "communicationBody": ...,
}

parent.create_case(**kwargs)
  1. See CreateCaseRequestRequestTypeDef

describe_attachment#

Returns the attachment that has the specified ID.

Type annotations and code completion for boto3.client("support").describe_attachment method. boto3 documentation

# describe_attachment method definition

def describe_attachment(
    self,
    *,
    attachmentId: str,
) -> DescribeAttachmentResponseTypeDef:  # (1)
    ...
  1. See DescribeAttachmentResponseTypeDef 
# describe_attachment method usage example with argument unpacking

kwargs: DescribeAttachmentRequestRequestTypeDef = {  # (1)
    "attachmentId": ...,
}

parent.describe_attachment(**kwargs)
  1. See DescribeAttachmentRequestRequestTypeDef

describe_cases#

Returns a list of cases that you specify by passing one or more case IDs.

Type annotations and code completion for boto3.client("support").describe_cases method. boto3 documentation

# describe_cases method definition

def describe_cases(
    self,
    *,
    caseIdList: Sequence[str] = ...,
    displayId: str = ...,
    afterTime: str = ...,
    beforeTime: str = ...,
    includeResolvedCases: bool = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    language: str = ...,
    includeCommunications: bool = ...,
) -> DescribeCasesResponseTypeDef:  # (1)
    ...
  1. See DescribeCasesResponseTypeDef 
# describe_cases method usage example with argument unpacking

kwargs: DescribeCasesRequestRequestTypeDef = {  # (1)
    "caseIdList": ...,
}

parent.describe_cases(**kwargs)
  1. See DescribeCasesRequestRequestTypeDef

describe_communications#

Returns communications and attachments for one or more support cases.

Type annotations and code completion for boto3.client("support").describe_communications method. boto3 documentation

# describe_communications method definition

def describe_communications(
    self,
    *,
    caseId: str,
    beforeTime: str = ...,
    afterTime: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribeCommunicationsResponseTypeDef:  # (1)
    ...
  1. See DescribeCommunicationsResponseTypeDef 
# describe_communications method usage example with argument unpacking

kwargs: DescribeCommunicationsRequestRequestTypeDef = {  # (1)
    "caseId": ...,
}

parent.describe_communications(**kwargs)
  1. See DescribeCommunicationsRequestRequestTypeDef

describe_create_case_options#

Returns a list of CreateCaseOption types along with the corresponding supported hours and language availability.

Type annotations and code completion for boto3.client("support").describe_create_case_options method. boto3 documentation

# describe_create_case_options method definition

def describe_create_case_options(
    self,
    *,
    issueType: str,
    serviceCode: str,
    language: str,
    categoryCode: str,
) -> DescribeCreateCaseOptionsResponseTypeDef:  # (1)
    ...
  1. See DescribeCreateCaseOptionsResponseTypeDef 
# describe_create_case_options method usage example with argument unpacking

kwargs: DescribeCreateCaseOptionsRequestRequestTypeDef = {  # (1)
    "issueType": ...,
    "serviceCode": ...,
    "language": ...,
    "categoryCode": ...,
}

parent.describe_create_case_options(**kwargs)
  1. See DescribeCreateCaseOptionsRequestRequestTypeDef

describe_services#

Returns the current list of Amazon Web Services services and a list of service categories for each service.

Type annotations and code completion for boto3.client("support").describe_services method. boto3 documentation

# describe_services method definition

def describe_services(
    self,
    *,
    serviceCodeList: Sequence[str] = ...,
    language: str = ...,
) -> DescribeServicesResponseTypeDef:  # (1)
    ...
  1. See DescribeServicesResponseTypeDef 
# describe_services method usage example with argument unpacking

kwargs: DescribeServicesRequestRequestTypeDef = {  # (1)
    "serviceCodeList": ...,
}

parent.describe_services(**kwargs)
  1. See DescribeServicesRequestRequestTypeDef

describe_severity_levels#

Returns the list of severity levels that you can assign to a support case.

Type annotations and code completion for boto3.client("support").describe_severity_levels method. boto3 documentation

# describe_severity_levels method definition

def describe_severity_levels(
    self,
    *,
    language: str = ...,
) -> DescribeSeverityLevelsResponseTypeDef:  # (1)
    ...
  1. See DescribeSeverityLevelsResponseTypeDef 
# describe_severity_levels method usage example with argument unpacking

kwargs: DescribeSeverityLevelsRequestRequestTypeDef = {  # (1)
    "language": ...,
}

parent.describe_severity_levels(**kwargs)
  1. See DescribeSeverityLevelsRequestRequestTypeDef

describe_supported_languages#

Returns a list of supported languages for a specified categoryCode, issueType and serviceCode.

Type annotations and code completion for boto3.client("support").describe_supported_languages method. boto3 documentation

# describe_supported_languages method definition

def describe_supported_languages(
    self,
    *,
    issueType: str,
    serviceCode: str,
    categoryCode: str,
) -> DescribeSupportedLanguagesResponseTypeDef:  # (1)
    ...
  1. See DescribeSupportedLanguagesResponseTypeDef 
# describe_supported_languages method usage example with argument unpacking

kwargs: DescribeSupportedLanguagesRequestRequestTypeDef = {  # (1)
    "issueType": ...,
    "serviceCode": ...,
    "categoryCode": ...,
}

parent.describe_supported_languages(**kwargs)
  1. See DescribeSupportedLanguagesRequestRequestTypeDef

describe_trusted_advisor_check_refresh_statuses#

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.

Type annotations and code completion for boto3.client("support").describe_trusted_advisor_check_refresh_statuses method. boto3 documentation

# describe_trusted_advisor_check_refresh_statuses method definition

def describe_trusted_advisor_check_refresh_statuses(
    self,
    *,
    checkIds: Sequence[str],
) -> DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef:  # (1)
    ...
  1. See DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef 
# describe_trusted_advisor_check_refresh_statuses method usage example with argument unpacking

kwargs: DescribeTrustedAdvisorCheckRefreshStatusesRequestRequestTypeDef = {  # (1)
    "checkIds": ...,
}

parent.describe_trusted_advisor_check_refresh_statuses(**kwargs)
  1. See DescribeTrustedAdvisorCheckRefreshStatusesRequestRequestTypeDef

describe_trusted_advisor_check_result#

Returns the results of the Trusted Advisor check that has the specified check ID.

Type annotations and code completion for boto3.client("support").describe_trusted_advisor_check_result method. boto3 documentation

# describe_trusted_advisor_check_result method definition

def describe_trusted_advisor_check_result(
    self,
    *,
    checkId: str,
    language: str = ...,
) -> DescribeTrustedAdvisorCheckResultResponseTypeDef:  # (1)
    ...
  1. See DescribeTrustedAdvisorCheckResultResponseTypeDef 
# describe_trusted_advisor_check_result method usage example with argument unpacking

kwargs: DescribeTrustedAdvisorCheckResultRequestRequestTypeDef = {  # (1)
    "checkId": ...,
}

parent.describe_trusted_advisor_check_result(**kwargs)
  1. See DescribeTrustedAdvisorCheckResultRequestRequestTypeDef

describe_trusted_advisor_check_summaries#

Returns the results for the Trusted Advisor check summaries for the check IDs that you specified.

Type annotations and code completion for boto3.client("support").describe_trusted_advisor_check_summaries method. boto3 documentation

# describe_trusted_advisor_check_summaries method definition

def describe_trusted_advisor_check_summaries(
    self,
    *,
    checkIds: Sequence[str],
) -> DescribeTrustedAdvisorCheckSummariesResponseTypeDef:  # (1)
    ...
  1. See DescribeTrustedAdvisorCheckSummariesResponseTypeDef 
# describe_trusted_advisor_check_summaries method usage example with argument unpacking

kwargs: DescribeTrustedAdvisorCheckSummariesRequestRequestTypeDef = {  # (1)
    "checkIds": ...,
}

parent.describe_trusted_advisor_check_summaries(**kwargs)
  1. See DescribeTrustedAdvisorCheckSummariesRequestRequestTypeDef

describe_trusted_advisor_checks#

Returns information about all available Trusted Advisor checks, including the name, ID, category, description, and metadata.

Type annotations and code completion for boto3.client("support").describe_trusted_advisor_checks method. boto3 documentation

# describe_trusted_advisor_checks method definition

def describe_trusted_advisor_checks(
    self,
    *,
    language: str,
) -> DescribeTrustedAdvisorChecksResponseTypeDef:  # (1)
    ...
  1. See DescribeTrustedAdvisorChecksResponseTypeDef 
# describe_trusted_advisor_checks method usage example with argument unpacking

kwargs: DescribeTrustedAdvisorChecksRequestRequestTypeDef = {  # (1)
    "language": ...,
}

parent.describe_trusted_advisor_checks(**kwargs)
  1. See DescribeTrustedAdvisorChecksRequestRequestTypeDef

generate_presigned_url#

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

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

refresh_trusted_advisor_check#

Refreshes the Trusted Advisor check that you specify using the check ID.

Type annotations and code completion for boto3.client("support").refresh_trusted_advisor_check method. boto3 documentation

# refresh_trusted_advisor_check method definition

def refresh_trusted_advisor_check(
    self,
    *,
    checkId: str,
) -> RefreshTrustedAdvisorCheckResponseTypeDef:  # (1)
    ...
  1. See RefreshTrustedAdvisorCheckResponseTypeDef 
# refresh_trusted_advisor_check method usage example with argument unpacking

kwargs: RefreshTrustedAdvisorCheckRequestRequestTypeDef = {  # (1)
    "checkId": ...,
}

parent.refresh_trusted_advisor_check(**kwargs)
  1. See RefreshTrustedAdvisorCheckRequestRequestTypeDef

resolve_case#

Resolves a support case.

Type annotations and code completion for boto3.client("support").resolve_case method. boto3 documentation

# resolve_case method definition

def resolve_case(
    self,
    *,
    caseId: str = ...,
) -> ResolveCaseResponseTypeDef:  # (1)
    ...
  1. See ResolveCaseResponseTypeDef 
# resolve_case method usage example with argument unpacking

kwargs: ResolveCaseRequestRequestTypeDef = {  # (1)
    "caseId": ...,
}

parent.resolve_case(**kwargs)
  1. See ResolveCaseRequestRequestTypeDef

get_paginator#

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