Skip to content

modify_verified_access_instance

modify_verified_access_instance(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    verified_access_instance_id: Optional[VerifiedAccessInstanceId] = None,
    description: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
    client_token: Optional[String] = None,
    cidr_endpoints_custom_sub_domain: Optional[String] = None,
) -> ModifyVerifiedAccessInstanceResult

Modifies the configuration of the specified Amazon Web Services Verified Access instance.

Parameters:

  • verified_access_instance_id (Optional[VerifiedAccessInstanceId], default: None ) –

    The ID of the Verified Access instance.

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

    A description for the Verified Access instance.

  • 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.

  • 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.

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

    The custom subdomain.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def modify_verified_access_instance(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    verified_access_instance_id: Optional[
        "capo_ec2.types.verified_access_instance_id.VerifiedAccessInstanceId"
    ] = None,
    description: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    client_token: Optional["capo_ec2.types.string.String"] = None,
    cidr_endpoints_custom_sub_domain: Optional[
        "capo_ec2.types.string.String"
    ] = None,
) -> "capo_ec2.types.modify_verified_access_instance_result.ModifyVerifiedAccessInstanceResult":
    """<p>Modifies the configuration of the specified Amazon Web Services Verified Access instance.</p>

    Args:
        verified_access_instance_id: <p>The ID of the Verified Access instance.</p>
        description: <p>A description for the Verified Access instance.</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>
        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>
        cidr_endpoints_custom_sub_domain: <p>The custom subdomain.</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_instance_request.ModifyVerifiedAccessInstanceRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.modify_verified_access_instance_result.ModifyVerifiedAccessInstanceResult"
    ]:
        import capo_ec2._operations.amazon_ec2.modify_verified_access_instance

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyVerifiedAccessInstance")
    )
    input_: capo_ec2.types.modify_verified_access_instance_request.ModifyVerifiedAccessInstanceRequest = {}
    if verified_access_instance_id is not None:
        input_["verified_access_instance_id"] = verified_access_instance_id
    if description is not None:
        input_["description"] = description
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if cidr_endpoints_custom_sub_domain is not None:
        input_["cidr_endpoints_custom_sub_domain"] = (
            cidr_endpoints_custom_sub_domain
        )

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