SupportAuthZ / Client / delete_support_permit

delete_support_permit

SupportAuthZ.Client.delete_support_permit(**kwargs)

Deletes a support permit, revoking the authorization previously granted to the AWS support operator.

See also: AWS API Documentation

Request Syntax

response = client.delete_support_permit(
    supportPermitIdentifier='string'
)
Parameters:

supportPermitIdentifier (string) –

[REQUIRED]

The Amazon Resource Name (ARN) or name of the support permit to delete.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'arn': 'string',
    'description': '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'
}

Response Structure

  • (dict) –

    • name (string) –

      The name of the deleted support permit.

    • arn (string) –

      The ARN of the deleted support permit.

    • description (string) –

      The description of the deleted support permit.

    • permit (dict) –

      The permit definition of the deleted permit.

      • 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 status of the support permit. Returns DELETING.

    • signingKeyInfo (dict) –

      The signing key information for the deleted 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 originally created.

    • supportCaseDisplayId (string) –

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

Exceptions