create_segment_definition async ¶

async def create_segment_definition(
    self,
    domain_name: "capo_customer_profiles.types.name.name",
    segment_definition_name: "capo_customer_profiles.types.name.name",
    display_name: "capo_customer_profiles.types.string1_to255.string1To255",
    *,
    config_overrides: Optional[AsyncCustomerProfilesClientConfig] = None,
    description: Optional[
        "capo_customer_profiles.types.sensitive_string1_to4000.sensitiveString1To4000"
    ] = None,
    segment_groups: Optional[
        "capo_customer_profiles.types.segment_group.SegmentGroup"
    ] = None,
    segment_sql_query: Optional[
        "capo_customer_profiles.types.sensitive_string1_to50000.sensitiveString1To50000"
    ] = None,
    segment_sort: Optional[
        "capo_customer_profiles.types.segment_sort.SegmentSort"
    ] = None,
    tags: Optional["capo_customer_profiles.types.tag_map.TagMap"] = None,
) -> "capo_customer_profiles.types.create_segment_definition_response.CreateSegmentDefinitionResponse":
    """<p>Creates a segment definition associated to the given domain.</p>

    Args:
        domain_name: <p>The unique name of the domain.</p>
        segment_definition_name: <p>The unique name of the segment definition.</p>
        display_name: <p>The display name of the segment definition.</p>
        description: <p>The description of the segment definition.</p>
        segment_groups: <p>Specifies the base segments and dimensions for a segment definition along with their respective relationship.</p>
        segment_sql_query: <p>The segment SQL query.</p>
        segment_sort: <p>The segment sort.</p>
        tags: <p>The tags used to organize, track, or control access for this resource.</p>

    Raises:
        capo_customer_profiles.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_customer_profiles.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_customer_profiles.errors.internal_server_exception.InternalServerException: <p>An internal service error occurred.</p>
        capo_customer_profiles.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_customer_profiles.errors.throttling_exception.ThrottlingException: <p>You exceeded the maximum number of requests.</p>
        capo_customer_profiles.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_customer_profiles.types.create_segment_definition_request.CreateSegmentDefinitionRequest]",
    ) -> AsyncOperationResponse[
        "capo_customer_profiles.types.create_segment_definition_response.CreateSegmentDefinitionResponse"
    ]:
        import capo_customer_profiles._operations.customer_profiles_20200815.create_segment_definition

        (
            output,
            http_response,
        ) = await capo_customer_profiles._operations.customer_profiles_20200815.create_segment_definition.async_create_segment_definition(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_customer_profiles.types.create_segment_definition_request.CreateSegmentDefinitionRequest",
    ) -> dict[str, Any]:
        import capo_customer_profiles.types.create_segment_definition_request

        return capo_customer_profiles.types.create_segment_definition_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_customer_profiles.types.create_segment_definition_response.CreateSegmentDefinitionResponse",
    ) -> dict[str, Any]:
        import capo_customer_profiles.types.create_segment_definition_response

        return capo_customer_profiles.types.create_segment_definition_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateSegmentDefinition",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_customer_profiles.types.create_segment_definition_request.CreateSegmentDefinitionRequest = {
        "domain_name": domain_name,
        "segment_definition_name": segment_definition_name,
        "display_name": display_name,
    }
    if description is not None:
        input_["description"] = description
    if segment_groups is not None:
        input_["segment_groups"] = segment_groups
    if segment_sql_query is not None:
        input_["segment_sql_query"] = segment_sql_query
    if segment_sort is not None:
        input_["segment_sort"] = segment_sort
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output