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

Class CreatePoolResponse

    • Method Detail

      • poolArn

        public final String poolArn()

        The Amazon Resource Name (ARN) for the pool.

        Returns:
        The Amazon Resource Name (ARN) for the pool.

      • poolId

        public final String poolId()

        The unique identifier for the pool.

        Returns:
        The unique identifier for the pool.

      • status

        public final PoolStatus status()

        The current status of the pool.

        • CREATING: The pool is currently being created and isn't yet available for use.

        • ACTIVE: The pool is active and available for use.

        • DELETING: The pool is being deleted.

        If the service returns an enum value that is not available in the current SDK version, status will return PoolStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The current status of the pool.

        • CREATING: The pool is currently being created and isn't yet available for use.

        • ACTIVE: The pool is active and available for use.

        • DELETING: The pool is being deleted.

        See Also:
        PoolStatus

      • statusAsString

        public final String statusAsString()

        The current status of the pool.

        • CREATING: The pool is currently being created and isn't yet available for use.

        • ACTIVE: The pool is active and available for use.

        • DELETING: The pool is being deleted.

        If the service returns an enum value that is not available in the current SDK version, status will return PoolStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The current status of the pool.

        • CREATING: The pool is currently being created and isn't yet available for use.

        • ACTIVE: The pool is active and available for use.

        • DELETING: The pool is being deleted.

        See Also:
        PoolStatus

      • messageType

        public final MessageType messageType()

        The type of message for the pool to use.

        If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

        Returns:
        The type of message for the pool to use.
        See Also:
        MessageType

      • messageTypeAsString

        public final String messageTypeAsString()

        The type of message for the pool to use.

        If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

        Returns:
        The type of message for the pool to use.
        See Also:
        MessageType

      • twoWayEnabled

        public final Boolean twoWayEnabled()

        By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

        Returns:
        By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

      • twoWayChannelArn

        public final String twoWayChannelArn()

        The Amazon Resource Name (ARN) of the two way channel.

        Returns:
        The Amazon Resource Name (ARN) of the two way channel.

      • twoWayChannelRole

        public final String twoWayChannelRole()

        An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

        Returns:
        An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

      • selfManagedOptOutsEnabled

        public final Boolean selfManagedOptOutsEnabled()

        By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

        Returns:
        By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

      • optOutListName

        public final String optOutListName()

        The name of the OptOutList associated with the pool.

        Returns:
        The name of the OptOutList associated with the pool.

      • sharedRoutesEnabled

        public final Boolean sharedRoutesEnabled()

        Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.

        Returns:
        Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.

      • deletionProtectionEnabled

        public final Boolean deletionProtectionEnabled()

        When set to true deletion protection is enabled. By default this is set to false.

        Returns:
        When set to true deletion protection is enabled. By default this is set to false.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

        An array of tags (key and value pairs) associated with the pool.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        An array of tags (key and value pairs) associated with the pool.

      • createdTimestamp

        public final Instant createdTimestamp()

        The time when the pool was created, in UNIX epoch time format.

        Returns:
        The time when the pool was created, in UNIX epoch time format.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object