Skip to content

get_segment_version async 

get_segment_version(
    application_id: __string,
    segment_id: __string,
    version: __string,
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
) -> GetSegmentVersionResponse

Retrieves information about the configuration, dimension, and other settings for a specific version of a 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.

  • segment_id (__string) –

    The unique identifier for the segment.

  • version (__string) –

    The unique version number (Version property) for the campaign version.

Raises:

Source code in docs_src/capo_pinpoint/_services/async_pinpoint.py 
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
async def get_segment_version(
    self,
    application_id: "capo_pinpoint.types.__string.__string",
    segment_id: "capo_pinpoint.types.__string.__string",
    version: "capo_pinpoint.types.__string.__string",
    *,
    config_overrides: Optional[AsyncPinpointClientConfig] = None,
) -> "capo_pinpoint.types.get_segment_version_response.GetSegmentVersionResponse":
    """<p>Retrieves information about the configuration, dimension, and other settings for a specific version of a 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>
        segment_id: <p>The unique identifier for the segment.</p>
        version: <p>The unique version number (Version property) for the campaign version.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pinpoint.types.get_segment_version_request.GetSegmentVersionRequest]",
    ) -> AsyncOperationResponse[
        "capo_pinpoint.types.get_segment_version_response.GetSegmentVersionResponse"
    ]:
        import capo_pinpoint._operations.pinpoint.get_segment_version

        (
            output,
            http_response,
        ) = await capo_pinpoint._operations.pinpoint.get_segment_version.async_get_segment_version(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSegmentVersion")
    )
    input_: capo_pinpoint.types.get_segment_version_request.GetSegmentVersionRequest = {
        "application_id": application_id,
        "segment_id": segment_id,
        "version": version,
    }

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