SearchAvailablePhoneNumbersRequest ¶

class SearchAvailablePhoneNumbersRequest(TypedDict, closed=True):
    target_arn: NotRequired["capo_connect.types.arn.ARN"]
    """<p>The Amazon Resource Name (ARN) for Connect Customer instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>"""
    instance_id: NotRequired["capo_connect.types.instance_id.InstanceId"]
    """<p>The identifier of the Connect Customer instance that phone numbers are claimed to. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>"""
    phone_number_country_code: (
        "capo_connect.types.phone_number_country_code.PhoneNumberCountryCode"
    )
    """<p>The ISO country code.</p>"""
    phone_number_type: "capo_connect.types.phone_number_type.PhoneNumberType"
    """<p>The type of phone number.</p>"""
    phone_number_prefix: NotRequired[
        "capo_connect.types.phone_number_prefix.PhoneNumberPrefix"
    ]
    """<p>The prefix of the phone number. If provided, it must contain <code>+</code> as part of the country code.</p>"""
    max_results: NotRequired["capo_connect.types.max_result10.MaxResult10"]
    """<p>The maximum number of results to return per page.</p>"""
    next_token: NotRequired["capo_connect.types.large_next_token.LargeNextToken"]
    """<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>"""