Skip to content

describe_registration_versions

describe_registration_versions(
    registration_id: RegistrationIdOrArn,
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    version_numbers: Optional[RegistrationVersionNumberList] = None,
    filters: Optional[RegistrationVersionFilterList] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> DescribeRegistrationVersionsResult

Retrieves the specified registration version.

Parameters:

  • registration_id (RegistrationIdOrArn) –

    The unique identifier for the registration.

  • version_numbers (Optional[RegistrationVersionNumberList], default: None ) –

    An array of registration version numbers.

  • filters (Optional[RegistrationVersionFilterList], default: None ) –

    An array of RegistrationVersionFilter objects to filter the results.

  • next_token (Optional[NextToken], default: None ) –

    The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to return per each request.

Raises:

Source code in docs_src/capo_pinpoint_sms_voice_v2/_services/pinpoint_sms_voice_v2.py
def describe_registration_versions(
    self,
    registration_id: "capo_pinpoint_sms_voice_v2.types.registration_id_or_arn.RegistrationIdOrArn",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    version_numbers: Optional[
        "capo_pinpoint_sms_voice_v2.types.registration_version_number_list.RegistrationVersionNumberList"
    ] = None,
    filters: Optional[
        "capo_pinpoint_sms_voice_v2.types.registration_version_filter_list.RegistrationVersionFilterList"
    ] = None,
    next_token: Optional[
        "capo_pinpoint_sms_voice_v2.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_pinpoint_sms_voice_v2.types.max_results.MaxResults"
    ] = None,
) -> "capo_pinpoint_sms_voice_v2.types.describe_registration_versions_result.DescribeRegistrationVersionsResult":
    """<p>Retrieves the specified registration version.</p>

    Args:
        registration_id: <p>The unique identifier for the registration.</p>
        version_numbers: <p>An array of registration version numbers.</p>
        filters: <p>An array of RegistrationVersionFilter objects to filter the results.</p>
        next_token: <p>The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.</p>
        max_results: <p>The maximum number of results to return per each request.</p>

    Raises:
        capo_pinpoint_sms_voice_v2.errors.access_denied_exception.AccessDeniedException: <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
        capo_pinpoint_sms_voice_v2.errors.internal_server_exception.InternalServerException: <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
        capo_pinpoint_sms_voice_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>A requested resource couldn't be found.</p>
        capo_pinpoint_sms_voice_v2.errors.throttling_exception.ThrottlingException: <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
        capo_pinpoint_sms_voice_v2.errors.validation_exception.ValidationException: <p>A validation exception for a field.</p>
        capo_pinpoint_sms_voice_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_sms_voice_v2.types.describe_registration_versions_request.DescribeRegistrationVersionsRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.describe_registration_versions_result.DescribeRegistrationVersionsResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.describe_registration_versions

        output, http_response = (
            capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.describe_registration_versions.describe_registration_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRegistrationVersions")
    )
    input_: capo_pinpoint_sms_voice_v2.types.describe_registration_versions_request.DescribeRegistrationVersionsRequest = {
        "registration_id": registration_id
    }
    if version_numbers is not None:
        input_["version_numbers"] = version_numbers
    if filters is not None:
        input_["filters"] = filters
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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