EC2 / Client / modify_verified_access_group_policy

modify_verified_access_group_policy#

EC2.Client.modify_verified_access_group_policy(**kwargs)#

Modifies the specified Amazon Web Services Verified Access group policy.

See also: AWS API Documentation

Request Syntax

response = client.modify_verified_access_group_policy(
    VerifiedAccessGroupId='string',
    PolicyEnabled=True|False,
    PolicyDocument='string',
    ClientToken='string',
    DryRun=True|False,
    SseSpecification={
        'CustomerManagedKeyEnabled': True|False,
        'KmsKeyArn': 'string'
    }
)
Parameters:

  • VerifiedAccessGroupId (string) –

    [REQUIRED]

    The ID of the Verified Access group.

  • PolicyEnabled (boolean) – The status of the Verified Access policy.

  • PolicyDocument (string) – The Verified Access policy document.

  • ClientToken (string) –

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

    This field is autopopulated if not provided.

  • DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • SseSpecification (dict) –

    The options for server side encryption.

    • CustomerManagedKeyEnabled (boolean) –

      Enable or disable the use of customer managed KMS keys for server side encryption.

      Valid values: True | False

    • KmsKeyArn (string) –

      The ARN of the KMS key.

Return type:

dict

Returns:

Response Syntax

{
    'PolicyEnabled': True|False,
    'PolicyDocument': 'string',
    'SseSpecification': {
        'CustomerManagedKeyEnabled': True|False,
        'KmsKeyArn': 'string'
    }
}

Response Structure

  • (dict) –

    • PolicyEnabled (boolean) –

      The status of the Verified Access policy.

    • PolicyDocument (string) –

      The Verified Access policy document.

    • SseSpecification (dict) –

      The options in use for server side encryption.

      • CustomerManagedKeyEnabled (boolean) –

        Indicates whether customer managed KMS keys are in use for server side encryption.

        Valid values: True | False

      • KmsKeyArn (string) –

        The ARN of the KMS key.