Skip to content

create_license_endpoint

create_license_endpoint(
    vpc_id: VpcId,
    subnet_ids: SubnetIdList,
    security_group_ids: SecurityGroupIdList,
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    tags: Optional[Tags] = None,
) -> CreateLicenseEndpointResponse

Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.

Parameters:

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

    The unique token which the server uses to recognize retries of the same request.

  • vpc_id (VpcId) –

    The VPC (virtual private cloud) ID to use with the license endpoint.

  • subnet_ids (SubnetIdList) –

    The subnet IDs.

  • security_group_ids (SecurityGroupIdList) –

    The security group IDs.

  • tags (Optional[Tags], default: None ) –

    Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Raises:

  • AccessDeniedException –

    You don't have permission to perform the action.

  • ConflictException –

    Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

  • InternalServerErrorException –

    Deadline Cloud can't process your request right now. Try again later.

  • ServiceQuotaExceededException –

    You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.

  • ThrottlingException –

    Your request exceeded a request rate quota.

  • ValidationException –

    The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_deadline/_services/deadline.py
def create_license_endpoint(
    self,
    vpc_id: "capo_deadline.types.vpc_id.VpcId",
    subnet_ids: "capo_deadline.types.subnet_id_list.SubnetIdList",
    security_group_ids: "capo_deadline.types.security_group_id_list.SecurityGroupIdList",
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
    client_token: Optional["capo_deadline.types.client_token.ClientToken"] = None,
    tags: Optional["capo_deadline.types.tags.Tags"] = None,
) -> "capo_deadline.types.create_license_endpoint_response.CreateLicenseEndpointResponse":
    """<p>Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.</p>

    Args:
        client_token: <p>The unique token which the server uses to recognize retries of the same request.</p>
        vpc_id: <p>The VPC (virtual private cloud) ID to use with the license endpoint.</p>
        subnet_ids: <p>The subnet IDs.</p>
        security_group_ids: <p>The security group IDs.</p>
        tags: <p>Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.</p>

    Raises:
        capo_deadline.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_deadline.errors.conflict_exception.ConflictException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_deadline.errors.internal_server_error_exception.InternalServerErrorException: <p>Deadline Cloud can't process your request right now. Try again later.</p>
        capo_deadline.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account.</p>
        capo_deadline.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota.</p>
        capo_deadline.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_deadline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_deadline.types.create_license_endpoint_request.CreateLicenseEndpointRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.create_license_endpoint_response.CreateLicenseEndpointResponse"
    ]:
        import capo_deadline._operations.deadline.create_license_endpoint

        output, http_response = (
            capo_deadline._operations.deadline.create_license_endpoint.create_license_endpoint(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateLicenseEndpoint")
    )
    input_: capo_deadline.types.create_license_endpoint_request.CreateLicenseEndpointRequest = {
        "vpc_id": vpc_id,
        "subnet_ids": subnet_ids,
        "security_group_ids": security_group_ids,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

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