Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.MediaConnect.UpdateFlowEntitlement

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.

Synopsis

data UpdateFlowEntitlement = UpdateFlowEntitlement' {
- description :: Maybe Text
- encryption :: Maybe UpdateEncryption
- entitlementStatus :: Maybe EntitlementStatus
- subscribers :: Maybe [Text]
- flowArn :: Text
- entitlementArn :: Text
}
newUpdateFlowEntitlement :: Text -> Text -> UpdateFlowEntitlement
updateFlowEntitlement_description :: Lens' UpdateFlowEntitlement (Maybe Text)
updateFlowEntitlement_encryption :: Lens' UpdateFlowEntitlement (Maybe UpdateEncryption)
updateFlowEntitlement_entitlementStatus :: Lens' UpdateFlowEntitlement (Maybe EntitlementStatus)
updateFlowEntitlement_subscribers :: Lens' UpdateFlowEntitlement (Maybe [Text])
updateFlowEntitlement_flowArn :: Lens' UpdateFlowEntitlement Text
updateFlowEntitlement_entitlementArn :: Lens' UpdateFlowEntitlement Text
data UpdateFlowEntitlementResponse = UpdateFlowEntitlementResponse' {
- entitlement :: Maybe Entitlement
- flowArn :: Maybe Text
- httpStatus :: Int
}
newUpdateFlowEntitlementResponse :: Int -> UpdateFlowEntitlementResponse
updateFlowEntitlementResponse_entitlement :: Lens' UpdateFlowEntitlementResponse (Maybe Entitlement)
updateFlowEntitlementResponse_flowArn :: Lens' UpdateFlowEntitlementResponse (Maybe Text)
updateFlowEntitlementResponse_httpStatus :: Lens' UpdateFlowEntitlementResponse Int

Creating a Request

data UpdateFlowEntitlement Source #

The entitlement fields that you want to update.

See: newUpdateFlowEntitlement smart constructor.

Constructors

UpdateFlowEntitlement'

Fields

description :: Maybe Text
A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
encryption :: Maybe UpdateEncryption
The type of encryption that will be used on the output associated with this entitlement.
entitlementStatus :: Maybe EntitlementStatus
An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.
subscribers :: Maybe [Text]
The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
flowArn :: Text
The flow that is associated with the entitlement that you want to update.
entitlementArn :: Text
The ARN of the entitlement that you want to update.

Instances

Instances details

ToJSON UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods toJSON :: UpdateFlowEntitlement -> Value # toEncoding :: UpdateFlowEntitlement -> Encoding # toJSONList :: [UpdateFlowEntitlement] -> Value # toEncodingList :: [UpdateFlowEntitlement] -> Encoding #
ToHeaders UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods toHeaders :: UpdateFlowEntitlement -> [Header] #
ToPath UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods toPath :: UpdateFlowEntitlement -> ByteString #
ToQuery UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods toQuery :: UpdateFlowEntitlement -> QueryString #
AWSRequest UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Associated Types type AWSResponse UpdateFlowEntitlement # Methods request :: (Service -> Service) -> UpdateFlowEntitlement -> Request UpdateFlowEntitlement # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateFlowEntitlement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateFlowEntitlement))) #
Generic UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Associated Types type Rep UpdateFlowEntitlement :: Type -> Type # Methods from :: UpdateFlowEntitlement -> Rep UpdateFlowEntitlement x # to :: Rep UpdateFlowEntitlement x -> UpdateFlowEntitlement #
Read UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods readsPrec :: Int -> ReadS UpdateFlowEntitlement # readList :: ReadS [UpdateFlowEntitlement] # readPrec :: ReadPrec UpdateFlowEntitlement # readListPrec :: ReadPrec [UpdateFlowEntitlement] #
Show UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods showsPrec :: Int -> UpdateFlowEntitlement -> ShowS # show :: UpdateFlowEntitlement -> String # showList :: [UpdateFlowEntitlement] -> ShowS #
NFData UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods rnf :: UpdateFlowEntitlement -> () #
Eq UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods (==) :: UpdateFlowEntitlement -> UpdateFlowEntitlement -> Bool # (/=) :: UpdateFlowEntitlement -> UpdateFlowEntitlement -> Bool #
Hashable UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods hashWithSalt :: Int -> UpdateFlowEntitlement -> Int # hash :: UpdateFlowEntitlement -> Int #
type AWSResponse UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement type AWSResponse UpdateFlowEntitlement = UpdateFlowEntitlementResponse
type Rep UpdateFlowEntitlement Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement type Rep UpdateFlowEntitlement = D1 ('MetaData "UpdateFlowEntitlement" "Amazonka.MediaConnect.UpdateFlowEntitlement" "amazonka-mediaconnect-2.0-KNF7B97aPsN1PZ2vBYFgux" 'False) (C1 ('MetaCons "UpdateFlowEntitlement'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "encryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdateEncryption)) :: S1 ('MetaSel ('Just "entitlementStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntitlementStatus)))) :: (S1 ('MetaSel ('Just "subscribers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "flowArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "entitlementArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateFlowEntitlement Source #

Arguments

:: Text	`UpdateFlowEntitlement`
-> Text	`UpdateFlowEntitlement`
-> UpdateFlowEntitlement

Create a value of UpdateFlowEntitlement with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateFlowEntitlement, updateFlowEntitlement_description - A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.

UpdateFlowEntitlement, updateFlowEntitlement_encryption - The type of encryption that will be used on the output associated with this entitlement.

UpdateFlowEntitlement, updateFlowEntitlement_entitlementStatus - An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.

UpdateFlowEntitlement, updateFlowEntitlement_subscribers - The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.

UpdateFlowEntitlement, updateFlowEntitlement_flowArn - The flow that is associated with the entitlement that you want to update.

UpdateFlowEntitlement, updateFlowEntitlement_entitlementArn - The ARN of the entitlement that you want to update.

Request Lenses

updateFlowEntitlement_description :: Lens' UpdateFlowEntitlement (Maybe Text) Source #

A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.

updateFlowEntitlement_encryption :: Lens' UpdateFlowEntitlement (Maybe UpdateEncryption) Source #

The type of encryption that will be used on the output associated with this entitlement.

updateFlowEntitlement_entitlementStatus :: Lens' UpdateFlowEntitlement (Maybe EntitlementStatus) Source #

An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.

updateFlowEntitlement_subscribers :: Lens' UpdateFlowEntitlement (Maybe [Text]) Source #

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.

updateFlowEntitlement_flowArn :: Lens' UpdateFlowEntitlement Text Source #

The flow that is associated with the entitlement that you want to update.

updateFlowEntitlement_entitlementArn :: Lens' UpdateFlowEntitlement Text Source #

The ARN of the entitlement that you want to update.

Destructuring the Response

data UpdateFlowEntitlementResponse Source #

See: newUpdateFlowEntitlementResponse smart constructor.

Constructors

UpdateFlowEntitlementResponse'
Fields entitlement :: Maybe Entitlement The new configuration of the entitlement that you updated. flowArn :: Maybe Text The ARN of the flow that this entitlement was granted on. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateFlowEntitlementResponse Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Associated Types type Rep UpdateFlowEntitlementResponse :: Type -> Type # Methods from :: UpdateFlowEntitlementResponse -> Rep UpdateFlowEntitlementResponse x # to :: Rep UpdateFlowEntitlementResponse x -> UpdateFlowEntitlementResponse #
Read UpdateFlowEntitlementResponse Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods readsPrec :: Int -> ReadS UpdateFlowEntitlementResponse # readList :: ReadS [UpdateFlowEntitlementResponse] # readPrec :: ReadPrec UpdateFlowEntitlementResponse # readListPrec :: ReadPrec [UpdateFlowEntitlementResponse] #
Show UpdateFlowEntitlementResponse Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods showsPrec :: Int -> UpdateFlowEntitlementResponse -> ShowS # show :: UpdateFlowEntitlementResponse -> String # showList :: [UpdateFlowEntitlementResponse] -> ShowS #
NFData UpdateFlowEntitlementResponse Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods rnf :: UpdateFlowEntitlementResponse -> () #
Eq UpdateFlowEntitlementResponse Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement Methods (==) :: UpdateFlowEntitlementResponse -> UpdateFlowEntitlementResponse -> Bool # (/=) :: UpdateFlowEntitlementResponse -> UpdateFlowEntitlementResponse -> Bool #
type Rep UpdateFlowEntitlementResponse Source #
Instance details Defined in Amazonka.MediaConnect.UpdateFlowEntitlement type Rep UpdateFlowEntitlementResponse = D1 ('MetaData "UpdateFlowEntitlementResponse" "Amazonka.MediaConnect.UpdateFlowEntitlement" "amazonka-mediaconnect-2.0-KNF7B97aPsN1PZ2vBYFgux" 'False) (C1 ('MetaCons "UpdateFlowEntitlementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entitlement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Entitlement)) :: (S1 ('MetaSel ('Just "flowArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateFlowEntitlementResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateFlowEntitlementResponse'`
-> UpdateFlowEntitlementResponse

Create a value of UpdateFlowEntitlementResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:entitlement:UpdateFlowEntitlementResponse', updateFlowEntitlementResponse_entitlement - The new configuration of the entitlement that you updated.

UpdateFlowEntitlement, updateFlowEntitlementResponse_flowArn - The ARN of the flow that this entitlement was granted on.

$sel:httpStatus:UpdateFlowEntitlementResponse', updateFlowEntitlementResponse_httpStatus - The response's http status code.

Response Lenses

updateFlowEntitlementResponse_entitlement :: Lens' UpdateFlowEntitlementResponse (Maybe Entitlement) Source #

The new configuration of the entitlement that you updated.

updateFlowEntitlementResponse_flowArn :: Lens' UpdateFlowEntitlementResponse (Maybe Text) Source #

The ARN of the flow that this entitlement was granted on.

updateFlowEntitlementResponse_httpStatus :: Lens' UpdateFlowEntitlementResponse Int Source #

The response's http status code.