describe_rcs_agent_country_launch_status ¶

def describe_rcs_agent_country_launch_status(
    self,
    rcs_agent_id: "capo_pinpoint_sms_voice_v2.types.rcs_agent_id_or_arn.RcsAgentIdOrArn",
    *,
    config_overrides: Optional[PinpointSMSVoiceV2ClientConfig] = None,
    iso_country_codes: Optional[
        "capo_pinpoint_sms_voice_v2.types.iso_country_code_list.IsoCountryCodeList"
    ] = None,
    filters: Optional[
        "capo_pinpoint_sms_voice_v2.types.country_launch_status_filter_list.CountryLaunchStatusFilterList"
    ] = None,
    max_results: Optional[
        "capo_pinpoint_sms_voice_v2.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_pinpoint_sms_voice_v2.types.next_token.NextToken"
    ] = None,
) -> "capo_pinpoint_sms_voice_v2.types.describe_rcs_agent_country_launch_status_result.DescribeRcsAgentCountryLaunchStatusResult":
    """<p>Retrieves the per-country launch status of an RCS agent, including carrier-level details for each country.</p>

    Args:
        rcs_agent_id: <p>The unique identifier of the RCS agent. You can use either the RcsAgentId or RcsAgentArn.</p>
        iso_country_codes: <p>An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, to filter the results.</p>
        filters: <p>An array of CountryLaunchStatusFilter objects to filter the results.</p>
        max_results: <p>The maximum number of results to return per each request.</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>

    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_rcs_agent_country_launch_status_request.DescribeRcsAgentCountryLaunchStatusRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_sms_voice_v2.types.describe_rcs_agent_country_launch_status_result.DescribeRcsAgentCountryLaunchStatusResult"
    ]:
        import capo_pinpoint_sms_voice_v2._operations.pinpoint_sms_voice_v2.describe_rcs_agent_country_launch_status

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRcsAgentCountryLaunchStatus")
    )
    input_: capo_pinpoint_sms_voice_v2.types.describe_rcs_agent_country_launch_status_request.DescribeRcsAgentCountryLaunchStatusRequest = {
        "rcs_agent_id": rcs_agent_id
    }
    if iso_country_codes is not None:
        input_["iso_country_codes"] = iso_country_codes
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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