Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

Interface DescribeOptOutListsRequest.Builder

    • Method Detail

      • optOutListNames

        DescribeOptOutListsRequest.Builder optOutListNames​(Collection<String> optOutListNames)

        The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

        If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

        Parameters:
        optOutListNames - The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

        If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optOutListNames

        DescribeOptOutListsRequest.Builder optOutListNames​(String... optOutListNames)

        The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

        If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

        Parameters:
        optOutListNames - The OptOutLists to show the details of. This is an array of strings that can be either the OptOutListName or OptOutListArn.

        If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        DescribeOptOutListsRequest.Builder nextToken​(String nextToken)

        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.

        Parameters:
        nextToken - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        DescribeOptOutListsRequest.Builder maxResults​(Integer maxResults)

        The maximum number of results to return per each request.

        Parameters:
        maxResults - The maximum number of results to return per each request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • owner

        DescribeOptOutListsRequest.Builder owner​(String owner)

        Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.

        Parameters:
        owner - Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Owner, Owner

      • owner

        DescribeOptOutListsRequest.Builder owner​(Owner owner)

        Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.

        Parameters:
        owner - Use SELF to filter the list of Opt-Out List to ones your account owns or use SHARED to filter on Opt-Out List shared with your account. The Owner and OptOutListNames parameters can't be used at the same time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Owner, Owner