libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaConnect.UpdateFlowEntitlement

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

Creating a Request

data UpdateFlowEntitlement Source #

The entitlement fields that you want to update.

See: newUpdateFlowEntitlement smart constructor.

Constructors

UpdateFlowEntitlement' 

Fields

  • 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.

  • 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.

  • 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
Eq UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

Read UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

Show UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

Generic UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

Associated Types

type Rep UpdateFlowEntitlement :: Type -> Type #

NFData UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

Methods

rnf :: UpdateFlowEntitlement -> () #

Hashable UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

ToJSON UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

AWSRequest UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

Associated Types

type AWSResponse UpdateFlowEntitlement #

ToHeaders UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

ToPath UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

ToQuery UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

type Rep UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

type Rep UpdateFlowEntitlement = D1 ('MetaData "UpdateFlowEntitlement" "Amazonka.MediaConnect.UpdateFlowEntitlement" "libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect" 'False) (C1 ('MetaCons "UpdateFlowEntitlement'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdateEncryption)) :*: (S1 ('MetaSel ('Just "entitlementStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EntitlementStatus)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (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)))))
type AWSResponse UpdateFlowEntitlement Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

newUpdateFlowEntitlement Source #

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:

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

$sel:entitlementStatus: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.

$sel:description: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.

$sel:subscribers: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.

$sel:flowArn:UpdateFlowEntitlement', updateFlowEntitlement_flowArn - The flow that is associated with the entitlement that you want to update.

$sel:entitlementArn:UpdateFlowEntitlement', updateFlowEntitlement_entitlementArn - The ARN of the entitlement that you want to update.

Request Lenses

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_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_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

Instances

Instances details
Eq UpdateFlowEntitlementResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

Read UpdateFlowEntitlementResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

Show UpdateFlowEntitlementResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

Generic UpdateFlowEntitlementResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

Associated Types

type Rep UpdateFlowEntitlementResponse :: Type -> Type #

NFData UpdateFlowEntitlementResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

type Rep UpdateFlowEntitlementResponse Source # 
Instance details

Defined in Amazonka.MediaConnect.UpdateFlowEntitlement

type Rep UpdateFlowEntitlementResponse = D1 ('MetaData "UpdateFlowEntitlementResponse" "Amazonka.MediaConnect.UpdateFlowEntitlement" "libZSservicesZSamazonka-mediaconnectZSamazonka-mediaconnect" 'False) (C1 ('MetaCons "UpdateFlowEntitlementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "flowArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "entitlement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Entitlement)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateFlowEntitlementResponse Source #

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:flowArn:UpdateFlowEntitlement', updateFlowEntitlementResponse_flowArn - The ARN of the flow that this entitlement was granted on.

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

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

Response Lenses

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

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

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

The new configuration of the entitlement that you updated.