Skip to content

create_segment 

create_segment(
    application_id: __string,
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    write_segment_request: Optional[WriteSegmentRequest] = None,
) -> CreateSegmentResponse

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

Parameters:

  • application_id (__string) –

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Raises:

Source code in docs_src/capo_pinpoint/_services/pinpoint.py 
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
def create_segment(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[PinpointClientConfig] = None,
    write_segment_request: Optional[
        "capo_pinpoint.types.write_segment_request.WriteSegmentRequest"
    ] = None,
) -> "capo_pinpoint.types.create_segment_response.CreateSegmentResponse":
    """<p>Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.</p>

    Args:
        application_id: <p>The unique identifier for the application. This identifier is displayed as the <b>Project ID</b> on the Amazon Pinpoint console.</p>

    Raises:
        capo_pinpoint.errors.bad_request_exception.BadRequestException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.forbidden_exception.ForbiddenException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.internal_server_error_exception.InternalServerErrorException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.method_not_allowed_exception.MethodNotAllowedException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.not_found_exception.NotFoundException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.payload_too_large_exception.PayloadTooLargeException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.too_many_requests_exception.TooManyRequestsException: <p>Provides information about an API request or response.</p>
        capo_pinpoint.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint.types.create_segment_request.CreateSegmentRequest]",
    ) -> OperationResponse[
        "capo_pinpoint.types.create_segment_response.CreateSegmentResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.create_segment

        output, http_response = (
            capo_pinpoint._operations.pinpoint.create_segment.create_segment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateSegment")
    )
    input_: capo_pinpoint.types.create_segment_request.CreateSegmentRequest = {
        "application_id": application_id
    }
    if write_segment_request is not None:
        input_["write_segment_request"] = write_segment_request

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