modify_ipam_scope ¶

def modify_ipam_scope(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_scope_id: Optional["capo_ec2.types.ipam_scope_id.IpamScopeId"] = None,
    description: Optional["capo_ec2.types.string.String"] = None,
    external_authority_configuration: Optional[
        "capo_ec2.types.external_authority_configuration.ExternalAuthorityConfiguration"
    ] = None,
    remove_external_authority_configuration: Optional[
        "capo_ec2.types.boolean.Boolean"
    ] = None,
) -> "capo_ec2.types.modify_ipam_scope_result.ModifyIpamScopeResult":
    """<p>Modify an IPAM scope.</p>

    Args:
        dry_run: <p>A check for 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>
        ipam_scope_id: <p>The ID of the scope you want to modify.</p>
        description: <p>The description of the scope you want to modify.</p>
        external_authority_configuration: <p>The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system.</p> <p>In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to Amazon Web Services while using Amazon VPC IPAM to manage subnets within those ranges.</p>
        remove_external_authority_configuration: <p>Remove the external authority configuration. <code>true</code> to remove.</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_ipam_scope_request.ModifyIpamScopeRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.modify_ipam_scope_result.ModifyIpamScopeResult"
    ]:
        import capo_ec2._operations.amazon_ec2.modify_ipam_scope

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyIpamScope")
    )
    input_: capo_ec2.types.modify_ipam_scope_request.ModifyIpamScopeRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_scope_id is not None:
        input_["ipam_scope_id"] = ipam_scope_id
    if description is not None:
        input_["description"] = description
    if external_authority_configuration is not None:
        input_["external_authority_configuration"] = (
            external_authority_configuration
        )
    if remove_external_authority_configuration is not None:
        input_["remove_external_authority_configuration"] = (
            remove_external_authority_configuration
        )

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