Network.AWS.SQS.ChangeMessageVisibility

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value you can set the value to is 12 hours. This means you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. (For more information visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide .)

For example, let's say you have a message and its default message visibility timeout is 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message would be extended by 10 minutes beyond the time of the ChangeMessageVisibility call. This results in a total visibility timeout of 13 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend beyond 12 hours, the request will be rejected.

Important: If you attempt to set the VisibilityTimeout to an amount more than the maximum time left, Amazon SQS returns an error. It will not automatically recalculate and increase the timeout to the maximum time remaining.

Important: Unlike with a queue, when you change the visibility timeout for a specific message, that timeout value is applied immediately but is not saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message the next time it is received reverts to the original timeout value, not the value you set with the ChangeMessageVisibility action.

Creating a Request

changeMessageVisibility

Arguments

:: Text

cmvQueueURL

-> Text

cmvReceiptHandle

-> Int

cmvVisibilityTimeout

-> ChangeMessageVisibility

Creates a value of ChangeMessageVisibility with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cmvQueueURL - The URL of the Amazon SQS queue to take action on. Queue URLs are case-sensitive.
• cmvReceiptHandle - The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the ReceiveMessage action.
• cmvVisibilityTimeout - The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.

data ChangeMessageVisibility

See: changeMessageVisibility smart constructor.

Instances

Eq ChangeMessageVisibility

Methods

(==) :: ChangeMessageVisibility -> ChangeMessageVisibility -> Bool

(/=) :: ChangeMessageVisibility -> ChangeMessageVisibility -> Bool

Data ChangeMessageVisibility

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ChangeMessageVisibility -> c ChangeMessageVisibility

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ChangeMessageVisibility

toConstr :: ChangeMessageVisibility -> Constr

dataTypeOf :: ChangeMessageVisibility -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ChangeMessageVisibility)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ChangeMessageVisibility)

gmapT :: (forall b. Data b => b -> b) -> ChangeMessageVisibility -> ChangeMessageVisibility

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ChangeMessageVisibility -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ChangeMessageVisibility -> r

gmapQ :: (forall d. Data d => d -> u) -> ChangeMessageVisibility -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ChangeMessageVisibility -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ChangeMessageVisibility -> m ChangeMessageVisibility

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ChangeMessageVisibility -> m ChangeMessageVisibility

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ChangeMessageVisibility -> m ChangeMessageVisibility

Read ChangeMessageVisibility

Methods

readsPrec :: Int -> ReadS ChangeMessageVisibility

readList :: ReadS [ChangeMessageVisibility]

readPrec :: ReadPrec ChangeMessageVisibility

readListPrec :: ReadPrec [ChangeMessageVisibility]

Show ChangeMessageVisibility

Methods

showsPrec :: Int -> ChangeMessageVisibility -> ShowS

show :: ChangeMessageVisibility -> String

showList :: [ChangeMessageVisibility] -> ShowS

Generic ChangeMessageVisibility

Associated Types

type Rep ChangeMessageVisibility :: * -> *

Methods

from :: ChangeMessageVisibility -> Rep ChangeMessageVisibility x

to :: Rep ChangeMessageVisibility x -> ChangeMessageVisibility

Hashable ChangeMessageVisibility

Methods

hashWithSalt :: Int -> ChangeMessageVisibility -> Int

hash :: ChangeMessageVisibility -> Int

NFData ChangeMessageVisibility

Methods

rnf :: ChangeMessageVisibility -> ()

AWSRequest ChangeMessageVisibility

Associated Types

type Rs ChangeMessageVisibility :: *

Methods

request :: ChangeMessageVisibility -> Request ChangeMessageVisibility

response :: MonadResource m => Logger -> Service -> Proxy * ChangeMessageVisibility -> ClientResponse -> m (Response ChangeMessageVisibility)

ToPath ChangeMessageVisibility

Methods

toPath :: ChangeMessageVisibility -> ByteString

ToHeaders ChangeMessageVisibility

Methods

toHeaders :: ChangeMessageVisibility -> [Header]

ToQuery ChangeMessageVisibility

Methods

toQuery :: ChangeMessageVisibility -> QueryString

type Rep ChangeMessageVisibility

type Rep ChangeMessageVisibility = D1 (MetaData "ChangeMessageVisibility" "Network.AWS.SQS.ChangeMessageVisibility" "amazonka-sqs-1.4.5-4rQHB5Mk9mo8cQvbOgAp4I" False) (C1 (MetaCons "ChangeMessageVisibility'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cmvQueueURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_cmvReceiptHandle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cmvVisibilityTimeout") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

type Rs ChangeMessageVisibility

type Rs ChangeMessageVisibility = ChangeMessageVisibilityResponse

Request Lenses

cmvQueueURL :: Lens' ChangeMessageVisibility Text

The URL of the Amazon SQS queue to take action on. Queue URLs are case-sensitive.

cmvReceiptHandle :: Lens' ChangeMessageVisibility Text

The receipt handle associated with the message whose visibility timeout should be changed. This parameter is returned by the ReceiveMessage action.

cmvVisibilityTimeout :: Lens' ChangeMessageVisibility Int

The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's visibility timeout.

Destructuring the Response

changeMessageVisibilityResponse :: ChangeMessageVisibilityResponse

Creates a value of ChangeMessageVisibilityResponse with the minimum fields required to make a request.

data ChangeMessageVisibilityResponse

See: changeMessageVisibilityResponse smart constructor.

Instances

Eq ChangeMessageVisibilityResponse

Methods

(==) :: ChangeMessageVisibilityResponse -> ChangeMessageVisibilityResponse -> Bool

(/=) :: ChangeMessageVisibilityResponse -> ChangeMessageVisibilityResponse -> Bool

Data ChangeMessageVisibilityResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ChangeMessageVisibilityResponse -> c ChangeMessageVisibilityResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ChangeMessageVisibilityResponse

toConstr :: ChangeMessageVisibilityResponse -> Constr

dataTypeOf :: ChangeMessageVisibilityResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ChangeMessageVisibilityResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ChangeMessageVisibilityResponse)

gmapT :: (forall b. Data b => b -> b) -> ChangeMessageVisibilityResponse -> ChangeMessageVisibilityResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ChangeMessageVisibilityResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ChangeMessageVisibilityResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ChangeMessageVisibilityResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ChangeMessageVisibilityResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ChangeMessageVisibilityResponse -> m ChangeMessageVisibilityResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ChangeMessageVisibilityResponse -> m ChangeMessageVisibilityResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ChangeMessageVisibilityResponse -> m ChangeMessageVisibilityResponse

Read ChangeMessageVisibilityResponse

Methods

readsPrec :: Int -> ReadS ChangeMessageVisibilityResponse

readList :: ReadS [ChangeMessageVisibilityResponse]

readPrec :: ReadPrec ChangeMessageVisibilityResponse

readListPrec :: ReadPrec [ChangeMessageVisibilityResponse]

Show ChangeMessageVisibilityResponse

Methods

showsPrec :: Int -> ChangeMessageVisibilityResponse -> ShowS

show :: ChangeMessageVisibilityResponse -> String

showList :: [ChangeMessageVisibilityResponse] -> ShowS

Generic ChangeMessageVisibilityResponse

Associated Types

type Rep ChangeMessageVisibilityResponse :: * -> *

Methods

from :: ChangeMessageVisibilityResponse -> Rep ChangeMessageVisibilityResponse x

to :: Rep ChangeMessageVisibilityResponse x -> ChangeMessageVisibilityResponse

NFData ChangeMessageVisibilityResponse

Methods

rnf :: ChangeMessageVisibilityResponse -> ()

type Rep ChangeMessageVisibilityResponse

type Rep ChangeMessageVisibilityResponse = D1 (MetaData "ChangeMessageVisibilityResponse" "Network.AWS.SQS.ChangeMessageVisibility" "amazonka-sqs-1.4.5-4rQHB5Mk9mo8cQvbOgAp4I" False) (C1 (MetaCons "ChangeMessageVisibilityResponse'" PrefixI False) U1)