Skip to content

modify_verified_access_endpoint_policy

modify_verified_access_endpoint_policy(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    verified_access_endpoint_id: Optional[VerifiedAccessEndpointId] = None,
    policy_enabled: Optional[Boolean] = None,
    policy_document: Optional[String] = None,
    client_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
    sse_specification: Optional[VerifiedAccessSseSpecificationRequest] = None,
) -> ModifyVerifiedAccessEndpointPolicyResult

Modifies the specified Amazon Web Services Verified Access endpoint policy.

Parameters:

  • verified_access_endpoint_id (Optional[VerifiedAccessEndpointId], default: None ) –

    The ID of the Verified Access endpoint.

  • policy_enabled (Optional[Boolean], default: None ) –

    The status of the Verified Access policy.

  • policy_document (Optional[String], default: None ) –

    The Verified Access policy document.

  • client_token (Optional[String], default: None ) –

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

  • dry_run (Optional[Boolean], default: None ) –

    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.

  • sse_specification (Optional[VerifiedAccessSseSpecificationRequest], default: None ) –

    The options for server side encryption.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def modify_verified_access_endpoint_policy(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    verified_access_endpoint_id: Optional[
        "capo_ec2.types.verified_access_endpoint_id.VerifiedAccessEndpointId"
    ] = None,
    policy_enabled: Optional["capo_ec2.types.boolean.Boolean"] = None,
    policy_document: Optional["capo_ec2.types.string.String"] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    sse_specification: Optional[
        "capo_ec2.types.verified_access_sse_specification_request.VerifiedAccessSseSpecificationRequest"
    ] = None,
) -> "capo_ec2.types.modify_verified_access_endpoint_policy_result.ModifyVerifiedAccessEndpointPolicyResult":
    """<p>Modifies the specified Amazon Web Services Verified Access endpoint policy.</p>

    Args:
        verified_access_endpoint_id: <p>The ID of the Verified Access endpoint.</p>
        policy_enabled: <p>The status of the Verified Access policy.</p>
        policy_document: <p>The Verified Access policy document.</p>
        client_token: <p>A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see <a href="https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html">Ensuring idempotency</a>.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        sse_specification: <p>The options for server side encryption.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.modify_verified_access_endpoint_policy_request.ModifyVerifiedAccessEndpointPolicyRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.modify_verified_access_endpoint_policy_result.ModifyVerifiedAccessEndpointPolicyResult"
    ]:
        import capo_ec2._operations.amazon_ec2.modify_verified_access_endpoint_policy

        output, http_response = (
            capo_ec2._operations.amazon_ec2.modify_verified_access_endpoint_policy.modify_verified_access_endpoint_policy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyVerifiedAccessEndpointPolicy")
    )
    input_: capo_ec2.types.modify_verified_access_endpoint_policy_request.ModifyVerifiedAccessEndpointPolicyRequest = {}
    if verified_access_endpoint_id is not None:
        input_["verified_access_endpoint_id"] = verified_access_endpoint_id
    if policy_enabled is not None:
        input_["policy_enabled"] = policy_enabled
    if policy_document is not None:
        input_["policy_document"] = policy_document
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if sse_specification is not None:
        input_["sse_specification"] = sse_specification

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output