SupportAuthZ / Client / list_support_permits

list_support_permits

SupportAuthZ.Client.list_support_permits(**kwargs)

Lists all support permits in the caller’s account. Use pagination to ensure that the operation returns quickly and successfully.

See also: AWS API Documentation

Request Syntax

response = client.list_support_permits(
    nextToken='string',
    maxResults=123,
    supportPermitStatuses=[
        'ACTIVE'|'INACTIVE'|'DELETING',
    ]
)

Parameters:

• nextToken (string) – The token for the next page of results.

• maxResults (integer) – The maximum number of results to return in a single call. Valid range is 1 to 100.

• supportPermitStatuses (list) –

  Filters the results by support permit status. Valid values: ACTIVE, INACTIVE, DELETING.

  • (string) –

    The status of a support permit.

Return type:

dict

Returns:

Response Syntax

{
    'supportPermits': [
        {
            'name': 'string',
            'arn': 'string',
            'permit': {
                'actions': {
                    'allActions': {},
                    'actions': [
                        'string',
                    ]
                },
                'resources': {
                    'allResourcesInRegion': {},
                    'resources': [
                        'string',
                    ]
                },
                'conditions': [
                    {
                        'allowAfter': datetime(2015, 1, 1),
                        'allowBefore': datetime(2015, 1, 1)
                    },
                ]
            },
            'status': 'ACTIVE'|'INACTIVE'|'DELETING',
            'signingKeyInfo': {
                'kmsKey': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'supportCaseDisplayId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • supportPermits (list) –

    The list of support permits.

    • (dict) –

      A summary of a support permit.

      • name (string) –

        The name of the support permit.

      • arn (string) –

        The ARN of the support permit.

      • permit (dict) –

        The permit definition.

        • actions (dict) –

          The set of actions that the support operator is authorized to perform.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: allActions, actions. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          

          • allActions (dict) –

            Authorizes all available support actions.

          • actions (list) –

            A list of specific support actions to authorize. Maximum of 10 actions.

            • (string) –

        • resources (dict) –

          The set of resources that the support operator is authorized to act upon.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: allResourcesInRegion, resources. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          

          • allResourcesInRegion (dict) –

            Authorizes the support operator to act on all resources in the Region.

          • resources (list) –

            A list of specific resource identifiers that the support operator is authorized to act upon. Maximum of 5 resources.

            • (string) –

        • conditions (list) –

          The time-window conditions that constrain when the permit is valid. Maximum of 2 conditions.

          • (dict) –

            A time-window condition that constrains when a support permit is valid.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: allowAfter, allowBefore. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
            

            • allowAfter (datetime) –

              The earliest time at which the permit becomes valid.

            • allowBefore (datetime) –

              The latest time at which the permit remains valid.

      • status (string) –

        The current status of the support permit.

      • signingKeyInfo (dict) –

        The signing key information for the permit.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: kmsKey. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • kmsKey (string) –

          The ARN of the AWS KMS key used to sign the permit. The key must have key spec ECC_NIST_P384 and key usage SIGN_VERIFY.

      • createdAt (datetime) –

        The timestamp when the permit was created.

      • supportCaseDisplayId (string) –

        The display identifier of the support case associated with the permit.

  • nextToken (string) –

    The token for the next page of results, or null if there are no more results.

Exceptions

• SupportAuthZ.Client.exceptions.ValidationException

• SupportAuthZ.Client.exceptions.AccessDeniedException

• SupportAuthZ.Client.exceptions.ThrottlingException

• SupportAuthZ.Client.exceptions.InternalServerException