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

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.

Usage example

client = boto3.client("support")

try:
    do_something(client)
except (
    client.AttachmentIdNotFound,
    client.AttachmentLimitExceeded,
    client.AttachmentSetExpired,
    client.AttachmentSetIdNotFound,
    client.AttachmentSetSizeLimitExceeded,
    client.CaseCreationLimitExceeded,
    client.CaseIdNotFound,
    client.ClientError,
    client.DescribeAttachmentLimitExceeded,
    client.InternalServerError,
) as e:
    print(e)

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

Method definition

def add_attachments_to_set(
    self,
    *,
    attachments: Sequence[AttachmentTypeDef],  # (1)
    attachmentSetId: str = ...,
) -> AddAttachmentsToSetResponseTypeDef:  # (2)
    ...

1. See AttachmentTypeDef
2. See AddAttachmentsToSetResponseTypeDef

Usage example with kwargs

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

Method definition

def add_communication_to_case(
    self,
    *,
    communicationBody: str,
    caseId: str = ...,
    ccEmailAddresses: Sequence[str] = ...,
    attachmentSetId: str = ...,
) -> AddCommunicationToCaseResponseTypeDef:  # (1)
    ...

1. See AddCommunicationToCaseResponseTypeDef

Usage example with kwargs

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

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

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

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

Usage example with kwargs

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

Method definition

def describe_attachment(
    self,
    *,
    attachmentId: str,
) -> DescribeAttachmentResponseTypeDef:  # (1)
    ...

1. See DescribeAttachmentResponseTypeDef

Usage example with kwargs

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

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

Usage example with kwargs

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

Method definition

def describe_communications(
    self,
    *,
    caseId: str,
    beforeTime: str = ...,
    afterTime: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> DescribeCommunicationsResponseTypeDef:  # (1)
    ...

1. See DescribeCommunicationsResponseTypeDef

Usage example with kwargs

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

parent.describe_communications(**kwargs)

1. See DescribeCommunicationsRequestRequestTypeDef

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

Method definition

def describe_services(
    self,
    *,
    serviceCodeList: Sequence[str] = ...,
    language: str = ...,
) -> DescribeServicesResponseTypeDef:  # (1)
    ...

1. See DescribeServicesResponseTypeDef

Usage example with kwargs

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

Method definition

def describe_severity_levels(
    self,
    *,
    language: str = ...,
) -> DescribeSeverityLevelsResponseTypeDef:  # (1)
    ...

1. See DescribeSeverityLevelsResponseTypeDef

Usage example with kwargs

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

parent.describe_severity_levels(**kwargs)

1. See DescribeSeverityLevelsRequestRequestTypeDef

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

Method definition

def describe_trusted_advisor_check_refresh_statuses(
    self,
    *,
    checkIds: Sequence[str],
) -> DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef:  # (1)
    ...

1. See DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef

Usage example with kwargs

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

Method definition

def describe_trusted_advisor_check_result(
    self,
    *,
    checkId: str,
    language: str = ...,
) -> DescribeTrustedAdvisorCheckResultResponseTypeDef:  # (1)
    ...

1. See DescribeTrustedAdvisorCheckResultResponseTypeDef

Usage example with kwargs

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

Method definition

def describe_trusted_advisor_check_summaries(
    self,
    *,
    checkIds: Sequence[str],
) -> DescribeTrustedAdvisorCheckSummariesResponseTypeDef:  # (1)
    ...

1. See DescribeTrustedAdvisorCheckSummariesResponseTypeDef

Usage example with kwargs

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

Method definition

def describe_trusted_advisor_checks(
    self,
    *,
    language: str,
) -> DescribeTrustedAdvisorChecksResponseTypeDef:  # (1)
    ...

1. See DescribeTrustedAdvisorChecksResponseTypeDef

Usage example with kwargs

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

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

Method definition

def refresh_trusted_advisor_check(
    self,
    *,
    checkId: str,
) -> RefreshTrustedAdvisorCheckResponseTypeDef:  # (1)
    ...

1. See RefreshTrustedAdvisorCheckResponseTypeDef

Usage example with kwargs

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

Method definition

def resolve_case(
    self,
    *,
    caseId: str = ...,
) -> ResolveCaseResponseTypeDef:  # (1)
    ...

1. See ResolveCaseResponseTypeDef

Usage example with kwargs

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.

• client.get_paginator("describe_cases") -> DescribeCasesPaginator
• client.get_paginator("describe_communications") -> DescribeCommunicationsPaginator