Support

Table of Contents

Client

class Support.Client

A low-level client representing AWS Support:

client = session.create_client('support')

These are the available methods:

add_attachments_to_set(**kwargs)

Adds one or more attachments to an attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.

An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the expiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.

See also: AWS API Documentation

Request Syntax

response = client.add_attachments_to_set(
    attachmentSetId='string',
    attachments=[
        {
            'fileName': 'string',
            'data': b'bytes'
        },
    ]
)
Parameters
  • attachmentSetId (string) -- The ID of the attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.
  • attachments (list) --

    [REQUIRED]

    One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.

    • (dict) --

      An attachment to a case communication. The attachment consists of the file name and the content of the file.

      • fileName (string) --

        The name of the attachment file.

      • data (bytes) --

        The content of the attachment file.

Return type

dict

Returns

Response Syntax

{
    'attachmentSetId': 'string',
    'expiryTime': 'string'
}

Response Structure

  • (dict) --

    The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

    • attachmentSetId (string) --

      The ID of the attachment set. If an attachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId was specified, the attachments are added to the specified set, if it exists.

    • expiryTime (string) --

      The time and date when the attachment set expires.

add_communication_to_case(**kwargs)

Adds additional customer communication to an AWS Support case. You use the caseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the ccEmailAddresses value. The communicationBody value contains the text of the communication.

The response indicates the success or failure of the request.

This operation implements a subset of the features of the AWS Support Center.

See also: AWS API Documentation

Request Syntax

response = client.add_communication_to_case(
    caseId='string',
    communicationBody='string',
    ccEmailAddresses=[
        'string',
    ],
    attachmentSetId='string'
)
Parameters
  • caseId (string) -- The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
  • communicationBody (string) --

    [REQUIRED]

    The body of an email communication to add to the support case.

  • ccEmailAddresses (list) --

    The email addresses in the CC line of an email to be added to the support case.

    • (string) --
  • attachmentSetId (string) -- The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet
Return type

dict

Returns

Response Syntax

{
    'result': True|False
}

Response Structure

  • (dict) --

    The result of the AddCommunicationToCase operation.

    • result (boolean) --

      True if AddCommunicationToCase succeeds. Otherwise, returns an error.

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_case(**kwargs)

Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:

  • issueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
  • serviceCode. The code for an AWS service. You obtain the serviceCode by calling DescribeServices .
  • categoryCode. The category for the service defined for the serviceCode value. You also obtain the category code for a service by calling DescribeServices . Each AWS service defines its own set of category codes.
  • severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels .
  • subject. The Subject field on the AWS Support Center Create Case page.
  • communicationBody. The Description field on the AWS Support Center Create Case page.
  • attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet .
  • language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
  • ccEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK .

Note

To add additional communication or attachments to an existing case, use AddCommunicationToCase .

A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.

See also: AWS API Documentation

Request Syntax

response = client.create_case(
    subject='string',
    serviceCode='string',
    severityCode='string',
    categoryCode='string',
    communicationBody='string',
    ccEmailAddresses=[
        'string',
    ],
    language='string',
    issueType='string',
    attachmentSetId='string'
)
Parameters
  • subject (string) --

    [REQUIRED]

    The title of the AWS Support case.

  • serviceCode (string) -- The code for the AWS service returned by the call to DescribeServices .
  • severityCode (string) --

    The code for the severity level returned by the call to DescribeSeverityLevels .

    Note

    The availability of severity levels depends on each customer's support subscription. In other words, your subscription may not necessarily require the urgent level of response time.

  • categoryCode (string) -- The category of problem for the AWS Support case.
  • communicationBody (string) --

    [REQUIRED]

    The communication body text when you create an AWS Support case by calling CreateCase .

  • ccEmailAddresses (list) --

    A list of email addresses that AWS Support copies on case correspondence.

    • (string) --
  • language (string) -- The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
  • issueType (string) -- The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
  • attachmentSetId (string) -- The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet .
Return type

dict

Returns

Response Syntax

{
    'caseId': 'string'
}

Response Structure

  • (dict) --

    The AWS Support case ID returned by a successful completion of the CreateCase operation.

    • caseId (string) --

      The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

describe_attachment(**kwargs)

Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.

See also: AWS API Documentation

Request Syntax

response = client.describe_attachment(
    attachmentId='string'
)
Parameters
attachmentId (string) --

[REQUIRED]

The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

Return type
dict
Returns
Response Syntax
{
    'attachment': {
        'fileName': 'string',
        'data': b'bytes'
    }
}

Response Structure

  • (dict) --

    The content and file name of the attachment returned by the DescribeAttachment operation.

    • attachment (dict) --

      The attachment content and file name.

      • fileName (string) --

        The name of the attachment file.

      • data (bytes) --

        The content of the attachment file.

describe_cases(**kwargs)

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the afterTime and beforeTime request parameters. You can set values for the includeResolvedCases and includeCommunications request parameters to control how much information is returned.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

The response returns the following in JSON format:

  • One or more CaseDetails data types.
  • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

See also: AWS API Documentation

Request Syntax

response = client.describe_cases(
    caseIdList=[
        'string',
    ],
    displayId='string',
    afterTime='string',
    beforeTime='string',
    includeResolvedCases=True|False,
    nextToken='string',
    maxResults=123,
    language='string',
    includeCommunications=True|False
)
Parameters
  • caseIdList (list) --

    A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

    • (string) --
  • displayId (string) -- The ID displayed for a case in the AWS Support Center user interface.
  • afterTime (string) -- The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • beforeTime (string) -- The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • includeResolvedCases (boolean) -- Specifies whether resolved support cases should be included in the DescribeCases results. The default is false .
  • nextToken (string) -- A resumption point for pagination.
  • maxResults (integer) -- The maximum number of results to return before paginating.
  • language (string) -- The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
  • includeCommunications (boolean) -- Specifies whether communications should be included in the DescribeCases results. The default is true .
Return type

dict

Returns

Response Syntax

{
    'cases': [
        {
            'caseId': 'string',
            'displayId': 'string',
            'subject': 'string',
            'status': 'string',
            'serviceCode': 'string',
            'categoryCode': 'string',
            'severityCode': 'string',
            'submittedBy': 'string',
            'timeCreated': 'string',
            'recentCommunications': {
                'communications': [
                    {
                        'caseId': 'string',
                        'body': 'string',
                        'submittedBy': 'string',
                        'timeCreated': 'string',
                        'attachmentSet': [
                            {
                                'attachmentId': 'string',
                                'fileName': 'string'
                            },
                        ]
                    },
                ],
                'nextToken': 'string'
            },
            'ccEmailAddresses': [
                'string',
            ],
            'language': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Returns an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.

    • cases (list) --

      The details for the cases that match the request.

      • (dict) --

        A JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. CaseDetails contains the following fields:

        • caseId. The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 .
        • categoryCode. The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices .
        • displayId. The identifier for the case on pages in the AWS Support Center.
        • language. The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
        • recentCommunications. One or more Communication objects. Fields of these objects are attachments , body , caseId , submittedBy , and timeCreated .
        • nextToken. A resumption point for pagination.
        • serviceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices .
        • severityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels .
        • status. The status of the case in the AWS Support Center.
        • subject. The subject line of the case.
        • submittedBy. The email address of the account that submitted the case.
        • timeCreated. The time the case was created, in ISO-8601 format.
        • caseId (string) --

          The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

        • displayId (string) --

          The ID displayed for the case in the AWS Support Center. This is a numeric string.

        • subject (string) --

          The subject line for the case in the AWS Support Center.

        • status (string) --

          The status of the case.

        • serviceCode (string) --

          The code for the AWS service returned by the call to DescribeServices .

        • categoryCode (string) --

          The category of problem for the AWS Support case.

        • severityCode (string) --

          The code for the severity level returned by the call to DescribeSeverityLevels .

        • submittedBy (string) --

          The email address of the account that submitted the case.

        • timeCreated (string) --

          The time that the case was case created in the AWS Support Center.

        • recentCommunications (dict) --

          The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

          • communications (list) --

            The five most recent communications associated with the case.

            • (dict) --

              A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.

              • caseId (string) --

                The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

              • body (string) --

                The text of the communication between the customer and AWS Support.

              • submittedBy (string) --

                The email address of the account that submitted the AWS Support case.

              • timeCreated (string) --

                The time the communication was created.

              • attachmentSet (list) --

                Information about the attachments to the case communication.

                • (dict) --

                  The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

                  • attachmentId (string) --

                    The ID of the attachment.

                  • fileName (string) --

                    The file name of the attachment.

          • nextToken (string) --

            A resumption point for pagination.

        • ccEmailAddresses (list) --

          The email addresses that receive copies of communication about the case.

          • (string) --
        • language (string) --

          The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

    • nextToken (string) --

      A resumption point for pagination.

describe_communications(**kwargs)

Returns communications (and attachments) for one or more support cases. You can use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a particular case.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

You can use the maxResults and nextToken parameters to control the pagination of the result set. Set maxResults to the number of cases you want displayed on each page, and use nextToken to specify the resumption of pagination.

See also: AWS API Documentation

Request Syntax

response = client.describe_communications(
    caseId='string',
    beforeTime='string',
    afterTime='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • caseId (string) --

    [REQUIRED]

    The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

  • beforeTime (string) -- The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • afterTime (string) -- The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • nextToken (string) -- A resumption point for pagination.
  • maxResults (integer) -- The maximum number of results to return before paginating.
Return type

dict

Returns

Response Syntax

{
    'communications': [
        {
            'caseId': 'string',
            'body': 'string',
            'submittedBy': 'string',
            'timeCreated': 'string',
            'attachmentSet': [
                {
                    'attachmentId': 'string',
                    'fileName': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    The communications returned by the DescribeCommunications operation.

    • communications (list) --

      The communications for the case.

      • (dict) --

        A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.

        • caseId (string) --

          The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

        • body (string) --

          The text of the communication between the customer and AWS Support.

        • submittedBy (string) --

          The email address of the account that submitted the AWS Support case.

        • timeCreated (string) --

          The time the communication was created.

        • attachmentSet (list) --

          Information about the attachments to the case communication.

          • (dict) --

            The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

            • attachmentId (string) --

              The ID of the attachment.

            • fileName (string) --

              The file name of the attachment.

    • nextToken (string) --

      A resumption point for pagination.

describe_services(**kwargs)

Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.

The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

See also: AWS API Documentation

Request Syntax

response = client.describe_services(
    serviceCodeList=[
        'string',
    ],
    language='string'
)
Parameters
  • serviceCodeList (list) --

    A JSON-formatted list of service codes available for AWS services.

    • (string) --
  • language (string) -- The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
Return type

dict

Returns

Response Syntax

{
    'services': [
        {
            'code': 'string',
            'name': 'string',
            'categories': [
                {
                    'code': 'string',
                    'name': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --

    The list of AWS services returned by the DescribeServices operation.

    • services (list) --

      A JSON-formatted list of AWS services.

      • (dict) --

        Information about an AWS service returned by the DescribeServices operation.

        • code (string) --

          The code for an AWS service returned by the DescribeServices response. The name element contains the corresponding friendly name.

        • name (string) --

          The friendly name for an AWS service. The code element contains the corresponding code.

        • categories (list) --

          A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase .

          • (dict) --

            A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.

            • code (string) --

              The category code for the support case.

            • name (string) --

              The category name for the support case.

describe_severity_levels(**kwargs)

Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.

See also: AWS API Documentation

Request Syntax

response = client.describe_severity_levels(
    language='string'
)
Parameters
language (string) -- The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
Return type
dict
Returns
Response Syntax
{
    'severityLevels': [
        {
            'code': 'string',
            'name': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    The list of severity levels returned by the DescribeSeverityLevels operation.

    • severityLevels (list) --

      The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.

      • (dict) --

        A code and name pair that represent a severity level that can be applied to a support case.

        • code (string) --

          One of four values: "low," "medium," "high," and "urgent". These values correspond to response times returned to the caller in severityLevel.name .

        • name (string) --

          The name of the severity level that corresponds to the severity level code.

describe_trusted_advisor_check_refresh_statuses(**kwargs)

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks .

Note

Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the DescribeTrustedAdvisorCheckRefreshStatuses operation for these checks causes an InvalidParameterValue error.

See also: AWS API Documentation

Request Syntax

response = client.describe_trusted_advisor_check_refresh_statuses(
    checkIds=[
        'string',
    ]
)
Parameters
checkIds (list) --

[REQUIRED]

The IDs of the Trusted Advisor checks to get the status of. Note: Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'statuses': [
        {
            'checkId': 'string',
            'status': 'string',
            'millisUntilNextRefreshable': 123
        },
    ]
}

Response Structure

  • (dict) --

    The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.

    • statuses (list) --

      The refresh status of the specified Trusted Advisor checks.

      • (dict) --

        The refresh status of a Trusted Advisor check.

        • checkId (string) --

          The unique identifier for the Trusted Advisor check.

        • status (string) --

          The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned".

        • millisUntilNextRefreshable (integer) --

          The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

describe_trusted_advisor_check_result(**kwargs)

Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks .

The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

  • TrustedAdvisorCategorySpecificSummary
  • TrustedAdvisorResourceDetail
  • TrustedAdvisorResourcesSummary

In addition, the response contains these fields:

  • status. The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
  • timestamp. The time of the last refresh of the check.
  • checkId. The unique identifier for the check.

See also: AWS API Documentation

Request Syntax

response = client.describe_trusted_advisor_check_result(
    checkId='string',
    language='string'
)
Parameters
  • checkId (string) --

    [REQUIRED]

    The unique identifier for the Trusted Advisor check.

  • language (string) -- The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
Return type

dict

Returns

Response Syntax

{
    'result': {
        'checkId': 'string',
        'timestamp': 'string',
        'status': 'string',
        'resourcesSummary': {
            'resourcesProcessed': 123,
            'resourcesFlagged': 123,
            'resourcesIgnored': 123,
            'resourcesSuppressed': 123
        },
        'categorySpecificSummary': {
            'costOptimizing': {
                'estimatedMonthlySavings': 123.0,
                'estimatedPercentMonthlySavings': 123.0
            }
        },
        'flaggedResources': [
            {
                'status': 'string',
                'region': 'string',
                'resourceId': 'string',
                'isSuppressed': True|False,
                'metadata': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.

    • result (dict) --

      The detailed results of the Trusted Advisor check.

      • checkId (string) --

        The unique identifier for the Trusted Advisor check.

      • timestamp (string) --

        The time of the last refresh of the check.

      • status (string) --

        The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".

      • resourcesSummary (dict) --

        Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries .

        • resourcesProcessed (integer) --

          The number of AWS resources that were analyzed by the Trusted Advisor check.

        • resourcesFlagged (integer) --

          The number of AWS resources that were flagged (listed) by the Trusted Advisor check.

        • resourcesIgnored (integer) --

          The number of AWS resources ignored by Trusted Advisor because information was unavailable.

        • resourcesSuppressed (integer) --

          The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.

      • categorySpecificSummary (dict) --

        Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

        • costOptimizing (dict) --

          The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

          • estimatedMonthlySavings (float) --

            The estimated monthly savings that might be realized if the recommended actions are taken.

          • estimatedPercentMonthlySavings (float) --

            The estimated percentage of savings that might be realized if the recommended actions are taken.

      • flaggedResources (list) --

        The details about each resource listed in the check result.

        • (dict) --

          Contains information about a resource identified by a Trusted Advisor check.

          • status (string) --

            The status code for the resource identified in the Trusted Advisor check.

          • region (string) --

            The AWS region in which the identified resource is located.

          • resourceId (string) --

            The unique identifier for the identified resource.

          • isSuppressed (boolean) --

            Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.

          • metadata (list) --

            Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks . Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

            • (string) --

describe_trusted_advisor_check_summaries(**kwargs)

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks .

The response contains an array of TrustedAdvisorCheckSummary objects.

See also: AWS API Documentation

Request Syntax

response = client.describe_trusted_advisor_check_summaries(
    checkIds=[
        'string',
    ]
)
Parameters
checkIds (list) --

[REQUIRED]

The IDs of the Trusted Advisor checks.

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'summaries': [
        {
            'checkId': 'string',
            'timestamp': 'string',
            'status': 'string',
            'hasFlaggedResources': True|False,
            'resourcesSummary': {
                'resourcesProcessed': 123,
                'resourcesFlagged': 123,
                'resourcesIgnored': 123,
                'resourcesSuppressed': 123
            },
            'categorySpecificSummary': {
                'costOptimizing': {
                    'estimatedMonthlySavings': 123.0,
                    'estimatedPercentMonthlySavings': 123.0
                }
            }
        },
    ]
}

Response Structure

  • (dict) --

    The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

    • summaries (list) --

      The summary information for the requested Trusted Advisor checks.

      • (dict) --

        A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.

        • checkId (string) --

          The unique identifier for the Trusted Advisor check.

        • timestamp (string) --

          The time of the last refresh of the check.

        • status (string) --

          The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".

        • hasFlaggedResources (boolean) --

          Specifies whether the Trusted Advisor check has flagged resources.

        • resourcesSummary (dict) --

          Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries .

          • resourcesProcessed (integer) --

            The number of AWS resources that were analyzed by the Trusted Advisor check.

          • resourcesFlagged (integer) --

            The number of AWS resources that were flagged (listed) by the Trusted Advisor check.

          • resourcesIgnored (integer) --

            The number of AWS resources ignored by Trusted Advisor because information was unavailable.

          • resourcesSuppressed (integer) --

            The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.

        • categorySpecificSummary (dict) --

          Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

          • costOptimizing (dict) --

            The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

            • estimatedMonthlySavings (float) --

              The estimated monthly savings that might be realized if the recommended actions are taken.

            • estimatedPercentMonthlySavings (float) --

              The estimated percentage of savings that might be realized if the recommended actions are taken.

describe_trusted_advisor_checks(**kwargs)

Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.

See also: AWS API Documentation

Request Syntax

response = client.describe_trusted_advisor_checks(
    language='string'
)
Parameters
language (string) --

[REQUIRED]

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

Return type
dict
Returns
Response Syntax
{
    'checks': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'category': 'string',
            'metadata': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) --

    Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

    • checks (list) --

      Information about all available Trusted Advisor checks.

      • (dict) --

        The description and metadata for a Trusted Advisor check.

        • id (string) --

          The unique identifier for the Trusted Advisor check.

        • name (string) --

          The display name for the Trusted Advisor check.

        • description (string) --

          The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).

        • category (string) --

          The category of the Trusted Advisor check.

        • metadata (list) --

          The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

          • (string) --
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

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

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
refresh_trusted_advisor_check(**kwargs)

Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks .

Note

Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the RefreshTrustedAdvisorCheck operation for these checks causes an InvalidParameterValue error.

The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:

  • status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".
  • millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.
  • checkId. The unique identifier for the check.

See also: AWS API Documentation

Request Syntax

response = client.refresh_trusted_advisor_check(
    checkId='string'
)
Parameters
checkId (string) --

[REQUIRED]

The unique identifier for the Trusted Advisor check to refresh. Note: Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

Return type
dict
Returns
Response Syntax
{
    'status': {
        'checkId': 'string',
        'status': 'string',
        'millisUntilNextRefreshable': 123
    }
}

Response Structure

  • (dict) --

    The current refresh status of a Trusted Advisor check.

    • status (dict) --

      The current refresh status for a check, including the amount of time until the check is eligible for refresh.

      • checkId (string) --

        The unique identifier for the Trusted Advisor check.

      • status (string) --

        The status of the Trusted Advisor check for which a refresh has been requested: "none", "enqueued", "processing", "success", or "abandoned".

      • millisUntilNextRefreshable (integer) --

        The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

resolve_case(**kwargs)

Takes a caseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

See also: AWS API Documentation

Request Syntax

response = client.resolve_case(
    caseId='string'
)
Parameters
caseId (string) -- The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47
Return type
dict
Returns
Response Syntax
{
    'initialCaseStatus': 'string',
    'finalCaseStatus': 'string'
}

Response Structure

  • (dict) --

    The status of the case returned by the ResolveCase operation.

    • initialCaseStatus (string) --

      The status of the case when the ResolveCase request was sent.

    • finalCaseStatus (string) --

      The status of the case after the ResolveCase request was processed.

Paginators

The available paginators are:

class Support.Paginator.DescribeCases
paginator = client.get_paginator('describe_cases')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Support.Client.describe_cases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    caseIdList=[
        'string',
    ],
    displayId='string',
    afterTime='string',
    beforeTime='string',
    includeResolvedCases=True|False,
    language='string',
    includeCommunications=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • caseIdList (list) --

    A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

    • (string) --
  • displayId (string) -- The ID displayed for a case in the AWS Support Center user interface.
  • afterTime (string) -- The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • beforeTime (string) -- The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • includeResolvedCases (boolean) -- Specifies whether resolved support cases should be included in the DescribeCases results. The default is false .
  • language (string) -- The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
  • includeCommunications (boolean) -- Specifies whether communications should be included in the DescribeCases results. The default is true .
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'cases': [
        {
            'caseId': 'string',
            'displayId': 'string',
            'subject': 'string',
            'status': 'string',
            'serviceCode': 'string',
            'categoryCode': 'string',
            'severityCode': 'string',
            'submittedBy': 'string',
            'timeCreated': 'string',
            'recentCommunications': {
                'communications': [
                    {
                        'caseId': 'string',
                        'body': 'string',
                        'submittedBy': 'string',
                        'timeCreated': 'string',
                        'attachmentSet': [
                            {
                                'attachmentId': 'string',
                                'fileName': 'string'
                            },
                        ]
                    },
                ],
                'nextToken': 'string'
            },
            'ccEmailAddresses': [
                'string',
            ],
            'language': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    Returns an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.

    • cases (list) --

      The details for the cases that match the request.

      • (dict) --

        A JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. CaseDetails contains the following fields:

        • caseId. The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47 .
        • categoryCode. The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices .
        • displayId. The identifier for the case on pages in the AWS Support Center.
        • language. The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.
        • recentCommunications. One or more Communication objects. Fields of these objects are attachments , body , caseId , submittedBy , and timeCreated .
        • nextToken. A resumption point for pagination.
        • serviceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices .
        • severityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels .
        • status. The status of the case in the AWS Support Center.
        • subject. The subject line of the case.
        • submittedBy. The email address of the account that submitted the case.
        • timeCreated. The time the case was created, in ISO-8601 format.
        • caseId (string) --

          The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

        • displayId (string) --

          The ID displayed for the case in the AWS Support Center. This is a numeric string.

        • subject (string) --

          The subject line for the case in the AWS Support Center.

        • status (string) --

          The status of the case.

        • serviceCode (string) --

          The code for the AWS service returned by the call to DescribeServices .

        • categoryCode (string) --

          The category of problem for the AWS Support case.

        • severityCode (string) --

          The code for the severity level returned by the call to DescribeSeverityLevels .

        • submittedBy (string) --

          The email address of the account that submitted the case.

        • timeCreated (string) --

          The time that the case was case created in the AWS Support Center.

        • recentCommunications (dict) --

          The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

          • communications (list) --

            The five most recent communications associated with the case.

            • (dict) --

              A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.

              • caseId (string) --

                The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

              • body (string) --

                The text of the communication between the customer and AWS Support.

              • submittedBy (string) --

                The email address of the account that submitted the AWS Support case.

              • timeCreated (string) --

                The time the communication was created.

              • attachmentSet (list) --

                Information about the attachments to the case communication.

                • (dict) --

                  The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

                  • attachmentId (string) --

                    The ID of the attachment.

                  • fileName (string) --

                    The file name of the attachment.

          • nextToken (string) --

            A resumption point for pagination.

        • ccEmailAddresses (list) --

          The email addresses that receive copies of communication about the case.

          • (string) --
        • language (string) --

          The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

    • NextToken (string) --

      A token to resume pagination.

class Support.Paginator.DescribeCommunications
paginator = client.get_paginator('describe_communications')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Support.Client.describe_communications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    caseId='string',
    beforeTime='string',
    afterTime='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • caseId (string) --

    [REQUIRED]

    The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

  • beforeTime (string) -- The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • afterTime (string) -- The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'communications': [
        {
            'caseId': 'string',
            'body': 'string',
            'submittedBy': 'string',
            'timeCreated': 'string',
            'attachmentSet': [
                {
                    'attachmentId': 'string',
                    'fileName': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    The communications returned by the DescribeCommunications operation.

    • communications (list) --

      The communications for the case.

      • (dict) --

        A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.

        • caseId (string) --

          The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

        • body (string) --

          The text of the communication between the customer and AWS Support.

        • submittedBy (string) --

          The email address of the account that submitted the AWS Support case.

        • timeCreated (string) --

          The time the communication was created.

        • attachmentSet (list) --

          Information about the attachments to the case communication.

          • (dict) --

            The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

            • attachmentId (string) --

              The ID of the attachment.

            • fileName (string) --

              The file name of the attachment.

    • NextToken (string) --

      A token to resume pagination.