SupportClient#
Auto-generated documentation for Support type annotations stubs module types-aiobotocore-support.
SupportClient#
Type annotations and code completion for session.create_client("support")
boto3 documentation
SupportClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_support.client import SupportClient
session = get_session()
async with session.create_client("support") as client:
client: SupportClientExceptions#
aiobotocore client exceptions are generated in runtime.
This class provides code completion for session.create_client("support").exceptions structure.
SupportClient.exceptions usage example
async with session.create_client("support") as client:
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,
client.ThrottlingException,
) as e:
print(e)SupportClient usage type checking example
from types_aiobotocore_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 session.create_client("support").add_attachments_to_set method.
boto3 documentation
# add_attachments_to_set method definition
await def add_attachments_to_set(
self,
*,
attachments: Sequence[AttachmentTypeDef], # (1)
attachmentSetId: str = ...,
) -> AddAttachmentsToSetResponseTypeDef: # (2)
...# add_attachments_to_set method usage example with argument unpacking
kwargs: AddAttachmentsToSetRequestRequestTypeDef = { # (1)
"attachments": ...,
}
parent.add_attachments_to_set(**kwargs)add_communication_to_case#
Adds additional customer communication to an Amazon Web Services Support case.
Type annotations and code completion for session.create_client("support").add_communication_to_case method.
boto3 documentation
# add_communication_to_case method definition
await def add_communication_to_case(
self,
*,
communicationBody: str,
caseId: str = ...,
ccEmailAddresses: Sequence[str] = ...,
attachmentSetId: str = ...,
) -> AddCommunicationToCaseResponseTypeDef: # (1)
...# add_communication_to_case method usage example with argument unpacking
kwargs: AddCommunicationToCaseRequestRequestTypeDef = { # (1)
"communicationBody": ...,
}
parent.add_communication_to_case(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_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 session.create_client("support").close method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...create_case#
Creates a case in the Amazon Web Services Support Center.
Type annotations and code completion for session.create_client("support").create_case method.
boto3 documentation
# create_case method definition
await 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)
...# create_case method usage example with argument unpacking
kwargs: CreateCaseRequestRequestTypeDef = { # (1)
"subject": ...,
"communicationBody": ...,
}
parent.create_case(**kwargs)describe_attachment#
Returns the attachment that has the specified ID.
Type annotations and code completion for session.create_client("support").describe_attachment method.
boto3 documentation
# describe_attachment method definition
await def describe_attachment(
self,
*,
attachmentId: str,
) -> DescribeAttachmentResponseTypeDef: # (1)
...# describe_attachment method usage example with argument unpacking
kwargs: DescribeAttachmentRequestRequestTypeDef = { # (1)
"attachmentId": ...,
}
parent.describe_attachment(**kwargs)describe_cases#
Returns a list of cases that you specify by passing one or more case IDs.
Type annotations and code completion for session.create_client("support").describe_cases method.
boto3 documentation
# describe_cases method definition
await 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)
...# describe_cases method usage example with argument unpacking
kwargs: DescribeCasesRequestRequestTypeDef = { # (1)
"caseIdList": ...,
}
parent.describe_cases(**kwargs)describe_communications#
Returns communications and attachments for one or more support cases.
Type annotations and code completion for session.create_client("support").describe_communications method.
boto3 documentation
# describe_communications method definition
await def describe_communications(
self,
*,
caseId: str,
beforeTime: str = ...,
afterTime: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> DescribeCommunicationsResponseTypeDef: # (1)
...# describe_communications method usage example with argument unpacking
kwargs: DescribeCommunicationsRequestRequestTypeDef = { # (1)
"caseId": ...,
}
parent.describe_communications(**kwargs)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 session.create_client("support").describe_create_case_options method.
boto3 documentation
# describe_create_case_options method definition
await def describe_create_case_options(
self,
*,
issueType: str,
serviceCode: str,
language: str,
categoryCode: str,
) -> DescribeCreateCaseOptionsResponseTypeDef: # (1)
...# describe_create_case_options method usage example with argument unpacking
kwargs: DescribeCreateCaseOptionsRequestRequestTypeDef = { # (1)
"issueType": ...,
"serviceCode": ...,
"language": ...,
"categoryCode": ...,
}
parent.describe_create_case_options(**kwargs)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 session.create_client("support").describe_services method.
boto3 documentation
# describe_services method definition
await def describe_services(
self,
*,
serviceCodeList: Sequence[str] = ...,
language: str = ...,
) -> DescribeServicesResponseTypeDef: # (1)
...# describe_services method usage example with argument unpacking
kwargs: DescribeServicesRequestRequestTypeDef = { # (1)
"serviceCodeList": ...,
}
parent.describe_services(**kwargs)describe_severity_levels#
Returns the list of severity levels that you can assign to a support case.
Type annotations and code completion for session.create_client("support").describe_severity_levels method.
boto3 documentation
# describe_severity_levels method definition
await def describe_severity_levels(
self,
*,
language: str = ...,
) -> DescribeSeverityLevelsResponseTypeDef: # (1)
...# describe_severity_levels method usage example with argument unpacking
kwargs: DescribeSeverityLevelsRequestRequestTypeDef = { # (1)
"language": ...,
}
parent.describe_severity_levels(**kwargs)describe_supported_languages#
Returns a list of supported languages for a specified categoryCode,
issueType and serviceCode.
Type annotations and code completion for session.create_client("support").describe_supported_languages method.
boto3 documentation
# describe_supported_languages method definition
await def describe_supported_languages(
self,
*,
issueType: str,
serviceCode: str,
categoryCode: str,
) -> DescribeSupportedLanguagesResponseTypeDef: # (1)
...# describe_supported_languages method usage example with argument unpacking
kwargs: DescribeSupportedLanguagesRequestRequestTypeDef = { # (1)
"issueType": ...,
"serviceCode": ...,
"categoryCode": ...,
}
parent.describe_supported_languages(**kwargs)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 session.create_client("support").describe_trusted_advisor_check_refresh_statuses method.
boto3 documentation
# describe_trusted_advisor_check_refresh_statuses method definition
await def describe_trusted_advisor_check_refresh_statuses(
self,
*,
checkIds: Sequence[str],
) -> DescribeTrustedAdvisorCheckRefreshStatusesResponseTypeDef: # (1)
...# describe_trusted_advisor_check_refresh_statuses method usage example with argument unpacking
kwargs: DescribeTrustedAdvisorCheckRefreshStatusesRequestRequestTypeDef = { # (1)
"checkIds": ...,
}
parent.describe_trusted_advisor_check_refresh_statuses(**kwargs)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 session.create_client("support").describe_trusted_advisor_check_result method.
boto3 documentation
# describe_trusted_advisor_check_result method definition
await def describe_trusted_advisor_check_result(
self,
*,
checkId: str,
language: str = ...,
) -> DescribeTrustedAdvisorCheckResultResponseTypeDef: # (1)
...# describe_trusted_advisor_check_result method usage example with argument unpacking
kwargs: DescribeTrustedAdvisorCheckResultRequestRequestTypeDef = { # (1)
"checkId": ...,
}
parent.describe_trusted_advisor_check_result(**kwargs)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 session.create_client("support").describe_trusted_advisor_check_summaries method.
boto3 documentation
# describe_trusted_advisor_check_summaries method definition
await def describe_trusted_advisor_check_summaries(
self,
*,
checkIds: Sequence[str],
) -> DescribeTrustedAdvisorCheckSummariesResponseTypeDef: # (1)
...# describe_trusted_advisor_check_summaries method usage example with argument unpacking
kwargs: DescribeTrustedAdvisorCheckSummariesRequestRequestTypeDef = { # (1)
"checkIds": ...,
}
parent.describe_trusted_advisor_check_summaries(**kwargs)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 session.create_client("support").describe_trusted_advisor_checks method.
boto3 documentation
# describe_trusted_advisor_checks method definition
await def describe_trusted_advisor_checks(
self,
*,
language: str,
) -> DescribeTrustedAdvisorChecksResponseTypeDef: # (1)
...# describe_trusted_advisor_checks method usage example with argument unpacking
kwargs: DescribeTrustedAdvisorChecksRequestRequestTypeDef = { # (1)
"language": ...,
}
parent.describe_trusted_advisor_checks(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("support").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("support").refresh_trusted_advisor_check method.
boto3 documentation
# refresh_trusted_advisor_check method definition
await def refresh_trusted_advisor_check(
self,
*,
checkId: str,
) -> RefreshTrustedAdvisorCheckResponseTypeDef: # (1)
...# refresh_trusted_advisor_check method usage example with argument unpacking
kwargs: RefreshTrustedAdvisorCheckRequestRequestTypeDef = { # (1)
"checkId": ...,
}
parent.refresh_trusted_advisor_check(**kwargs)resolve_case#
Resolves a support case.
Type annotations and code completion for session.create_client("support").resolve_case method.
boto3 documentation
# resolve_case method definition
await def resolve_case(
self,
*,
caseId: str = ...,
) -> ResolveCaseResponseTypeDef: # (1)
...# resolve_case method usage example with argument unpacking
kwargs: ResolveCaseRequestRequestTypeDef = { # (1)
"caseId": ...,
}
parent.resolve_case(**kwargs)__aenter__#
Type annotations and code completion for session.create_client("support").__aenter__ method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> SupportClient:
...__aexit__#
Type annotations and code completion for session.create_client("support").__aexit__ method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...get_paginator#
Type annotations and code completion for session.create_client("support").get_paginator method with overloads.
client.get_paginator("describe_cases")-> DescribeCasesPaginatorclient.get_paginator("describe_communications")-> DescribeCommunicationsPaginator