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.SNS.AddPermission

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.

To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

Synopsis

data AddPermission = AddPermission' {
- topicArn :: Text
- label :: Text
- aWSAccountId :: [Text]
- actionName :: [Text]
}
newAddPermission :: Text -> Text -> AddPermission
addPermission_topicArn :: Lens' AddPermission Text
addPermission_label :: Lens' AddPermission Text
addPermission_aWSAccountId :: Lens' AddPermission [Text]
addPermission_actionName :: Lens' AddPermission [Text]
data AddPermissionResponse = AddPermissionResponse' {
}
newAddPermissionResponse :: AddPermissionResponse

Creating a Request

data AddPermission Source #

See: newAddPermission smart constructor.

Constructors

AddPermission'

Fields

topicArn :: Text
The ARN of the topic whose access control policy you wish to modify.
label :: Text
A unique identifier for the new policy statement.
aWSAccountId :: [Text]
The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.
actionName :: [Text]
The action you want to allow for the specified principal(s).
Valid values: Any Amazon SNS action name, for example Publish.

Instances

Instances details

ToHeaders AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods toHeaders :: AddPermission -> [Header] #
ToPath AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods toPath :: AddPermission -> ByteString #
ToQuery AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods toQuery :: AddPermission -> QueryString #
AWSRequest AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission Associated Types type AWSResponse AddPermission # Methods request :: (Service -> Service) -> AddPermission -> Request AddPermission # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AddPermission -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AddPermission))) #
Generic AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission Associated Types type Rep AddPermission :: Type -> Type # Methods from :: AddPermission -> Rep AddPermission x # to :: Rep AddPermission x -> AddPermission #
Read AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods readsPrec :: Int -> ReadS AddPermission # readList :: ReadS [AddPermission] # readPrec :: ReadPrec AddPermission # readListPrec :: ReadPrec [AddPermission] #
Show AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods showsPrec :: Int -> AddPermission -> ShowS # show :: AddPermission -> String # showList :: [AddPermission] -> ShowS #
NFData AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods rnf :: AddPermission -> () #
Eq AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods (==) :: AddPermission -> AddPermission -> Bool # (/=) :: AddPermission -> AddPermission -> Bool #
Hashable AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods hashWithSalt :: Int -> AddPermission -> Int # hash :: AddPermission -> Int #
type AWSResponse AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission type AWSResponse AddPermission = AddPermissionResponse
type Rep AddPermission Source #
Instance details Defined in Amazonka.SNS.AddPermission type Rep AddPermission = D1 ('MetaData "AddPermission" "Amazonka.SNS.AddPermission" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "AddPermission'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "topicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "aWSAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "actionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newAddPermission Source #

Arguments

:: Text	`AddPermission`
-> Text	`$sel:label:AddPermission'`
-> AddPermission

Create a value of AddPermission 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:

AddPermission, addPermission_topicArn - The ARN of the topic whose access control policy you wish to modify.

$sel:label:AddPermission', addPermission_label - A unique identifier for the new policy statement.

$sel:aWSAccountId:AddPermission', addPermission_aWSAccountId - The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.

$sel:actionName:AddPermission', addPermission_actionName - The action you want to allow for the specified principal(s).

Valid values: Any Amazon SNS action name, for example Publish.

Request Lenses

addPermission_topicArn :: Lens' AddPermission Text Source #

The ARN of the topic whose access control policy you wish to modify.

addPermission_label :: Lens' AddPermission Text Source #

A unique identifier for the new policy statement.

addPermission_aWSAccountId :: Lens' AddPermission [Text] Source #

The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service.

addPermission_actionName :: Lens' AddPermission [Text] Source #

The action you want to allow for the specified principal(s).

Valid values: Any Amazon SNS action name, for example Publish.

Destructuring the Response

data AddPermissionResponse Source #

See: newAddPermissionResponse smart constructor.

Constructors

AddPermissionResponse'

Instances

Instances details

Generic AddPermissionResponse Source #
Instance details Defined in Amazonka.SNS.AddPermission Associated Types type Rep AddPermissionResponse :: Type -> Type # Methods from :: AddPermissionResponse -> Rep AddPermissionResponse x # to :: Rep AddPermissionResponse x -> AddPermissionResponse #
Read AddPermissionResponse Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods readsPrec :: Int -> ReadS AddPermissionResponse # readList :: ReadS [AddPermissionResponse] # readPrec :: ReadPrec AddPermissionResponse # readListPrec :: ReadPrec [AddPermissionResponse] #
Show AddPermissionResponse Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods showsPrec :: Int -> AddPermissionResponse -> ShowS # show :: AddPermissionResponse -> String # showList :: [AddPermissionResponse] -> ShowS #
NFData AddPermissionResponse Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods rnf :: AddPermissionResponse -> () #
Eq AddPermissionResponse Source #
Instance details Defined in Amazonka.SNS.AddPermission Methods (==) :: AddPermissionResponse -> AddPermissionResponse -> Bool # (/=) :: AddPermissionResponse -> AddPermissionResponse -> Bool #
type Rep AddPermissionResponse Source #
Instance details Defined in Amazonka.SNS.AddPermission type Rep AddPermissionResponse = D1 ('MetaData "AddPermissionResponse" "Amazonka.SNS.AddPermission" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "AddPermissionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newAddPermissionResponse :: AddPermissionResponse Source #

Create a value of AddPermissionResponse with all optional fields omitted.

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