Skip to content

create_usage_profile

create_usage_profile(
    name: NameString,
    configuration: ProfileConfiguration,
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    description: Optional[DescriptionString] = None,
    tags: Optional[TagsMap] = None,
) -> CreateUsageProfileResponse

Creates an Glue usage profile.

Parameters:

  • name (NameString) –

    The name of the usage profile.

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

    A description of the usage profile.

  • configuration (ProfileConfiguration) –

    A ProfileConfiguration object specifying the job and session values for the profile.

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

    A list of tags applied to the usage profile.

Raises:

Source code in docs_src/capo_glue/_services/glue.py
def create_usage_profile(
    self,
    name: "capo_glue.types.name_string.NameString",
    configuration: "capo_glue.types.profile_configuration.ProfileConfiguration",
    *,
    config_overrides: Optional[GlueClientConfig] = None,
    description: Optional[
        "capo_glue.types.description_string.DescriptionString"
    ] = None,
    tags: Optional["capo_glue.types.tags_map.TagsMap"] = None,
) -> "capo_glue.types.create_usage_profile_response.CreateUsageProfileResponse":
    """<p>Creates an Glue usage profile.</p>

    Args:
        name: <p>The name of the usage profile.</p>
        description: <p>A description of the usage profile.</p>
        configuration: <p>A <code>ProfileConfiguration</code> object specifying the job and session values for the profile.</p>
        tags: <p>A list of tags applied to the usage profile.</p>

    Raises:
        capo_glue.errors.already_exists_exception.AlreadyExistsException: <p>A resource to be created or added already exists.</p>
        capo_glue.errors.internal_service_exception.InternalServiceException: <p>An internal service error occurred.</p>
        capo_glue.errors.invalid_input_exception.InvalidInputException: <p>The input provided was not valid.</p>
        capo_glue.errors.operation_not_supported_exception.OperationNotSupportedException: <p>The operation is not available in the region.</p>
        capo_glue.errors.operation_timeout_exception.OperationTimeoutException: <p>The operation timed out.</p>
        capo_glue.errors.resource_number_limit_exceeded_exception.ResourceNumberLimitExceededException: <p>A resource numerical limit was exceeded.</p>
        capo_glue.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_glue.types.create_usage_profile_request.CreateUsageProfileRequest]",
    ) -> OperationResponse[
        "capo_glue.types.create_usage_profile_response.CreateUsageProfileResponse"
    ]:
        import capo_glue._operations.aws_glue.create_usage_profile

        output, http_response = (
            capo_glue._operations.aws_glue.create_usage_profile.create_usage_profile(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateUsageProfile")
    )
    input_: capo_glue.types.create_usage_profile_request.CreateUsageProfileRequest = {
        "name": name,
        "configuration": configuration,
    }
    if description is not None:
        input_["description"] = description
    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