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.XRay.PutResourcePolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.

Synopsis

data PutResourcePolicy = PutResourcePolicy' {
- bypassPolicyLockoutCheck :: Maybe Bool
- policyRevisionId :: Maybe Text
- policyName :: Text
- policyDocument :: Text
}
newPutResourcePolicy :: Text -> Text -> PutResourcePolicy
putResourcePolicy_bypassPolicyLockoutCheck :: Lens' PutResourcePolicy (Maybe Bool)
putResourcePolicy_policyRevisionId :: Lens' PutResourcePolicy (Maybe Text)
putResourcePolicy_policyName :: Lens' PutResourcePolicy Text
putResourcePolicy_policyDocument :: Lens' PutResourcePolicy Text
data PutResourcePolicyResponse = PutResourcePolicyResponse' {
- resourcePolicy :: Maybe ResourcePolicy
- httpStatus :: Int
}
newPutResourcePolicyResponse :: Int -> PutResourcePolicyResponse
putResourcePolicyResponse_resourcePolicy :: Lens' PutResourcePolicyResponse (Maybe ResourcePolicy)
putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int

Creating a Request

data PutResourcePolicy Source #

See: newPutResourcePolicy smart constructor.

Constructors

PutResourcePolicy'

Fields

bypassPolicyLockoutCheck :: Maybe Bool
A flag to indicate whether to bypass the resource policy lockout safety check.
Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutResourcePolicy request.
The default value is false.
policyRevisionId :: Maybe Text
Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.
If the policy revision id does not match the latest revision id, the operation will fail with an InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a resource policy with the same name already exists.
policyName :: Text
The name of the resource policy. Must be unique within a specific Amazon Web Services account.
policyDocument :: Text
The resource policy document, which can be up to 5kb in size.

Instances

Instances details

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

newPutResourcePolicy Source #

Arguments

:: Text	`PutResourcePolicy`
-> Text	`PutResourcePolicy`
-> PutResourcePolicy

Create a value of PutResourcePolicy 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:bypassPolicyLockoutCheck:PutResourcePolicy', putResourcePolicy_bypassPolicyLockoutCheck - A flag to indicate whether to bypass the resource policy lockout safety check.

Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.

Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutResourcePolicy request.

The default value is false.

PutResourcePolicy, putResourcePolicy_policyRevisionId - Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.

If the policy revision id does not match the latest revision id, the operation will fail with an InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a resource policy with the same name already exists.

PutResourcePolicy, putResourcePolicy_policyName - The name of the resource policy. Must be unique within a specific Amazon Web Services account.

PutResourcePolicy, putResourcePolicy_policyDocument - The resource policy document, which can be up to 5kb in size.

Request Lenses

putResourcePolicy_bypassPolicyLockoutCheck :: Lens' PutResourcePolicy (Maybe Bool) Source #

A flag to indicate whether to bypass the resource policy lockout safety check.

Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately.

Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutResourcePolicy request.

The default value is false.

putResourcePolicy_policyRevisionId :: Lens' PutResourcePolicy (Maybe Text) Source #

Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account.

If the policy revision id does not match the latest revision id, the operation will fail with an InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a resource policy with the same name already exists.

putResourcePolicy_policyName :: Lens' PutResourcePolicy Text Source #

The name of the resource policy. Must be unique within a specific Amazon Web Services account.

putResourcePolicy_policyDocument :: Lens' PutResourcePolicy Text Source #

The resource policy document, which can be up to 5kb in size.

Destructuring the Response

data PutResourcePolicyResponse Source #

See: newPutResourcePolicyResponse smart constructor.

Constructors

PutResourcePolicyResponse'
Fields resourcePolicy :: Maybe ResourcePolicy The resource policy document, as provided in the `PutResourcePolicyRequest`. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.XRay.PutResourcePolicy Associated Types type Rep PutResourcePolicyResponse :: Type -> Type # Methods from :: PutResourcePolicyResponse -> Rep PutResourcePolicyResponse x # to :: Rep PutResourcePolicyResponse x -> PutResourcePolicyResponse #
Read PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.XRay.PutResourcePolicy Methods readsPrec :: Int -> ReadS PutResourcePolicyResponse # readList :: ReadS [PutResourcePolicyResponse] # readPrec :: ReadPrec PutResourcePolicyResponse # readListPrec :: ReadPrec [PutResourcePolicyResponse] #
Show PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.XRay.PutResourcePolicy Methods showsPrec :: Int -> PutResourcePolicyResponse -> ShowS # show :: PutResourcePolicyResponse -> String # showList :: [PutResourcePolicyResponse] -> ShowS #
NFData PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.XRay.PutResourcePolicy Methods rnf :: PutResourcePolicyResponse -> () #
Eq PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.XRay.PutResourcePolicy Methods (==) :: PutResourcePolicyResponse -> PutResourcePolicyResponse -> Bool # (/=) :: PutResourcePolicyResponse -> PutResourcePolicyResponse -> Bool #
type Rep PutResourcePolicyResponse Source #
Instance details Defined in Amazonka.XRay.PutResourcePolicy type Rep PutResourcePolicyResponse = D1 ('MetaData "PutResourcePolicyResponse" "Amazonka.XRay.PutResourcePolicy" "amazonka-xray-2.0-EVMSPoflqtHB9ZqvEIOE4Q" 'False) (C1 ('MetaCons "PutResourcePolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourcePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourcePolicy)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutResourcePolicyResponse Source #

Arguments

:: Int	`PutResourcePolicyResponse`
-> PutResourcePolicyResponse

Create a value of PutResourcePolicyResponse 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:resourcePolicy:PutResourcePolicyResponse', putResourcePolicyResponse_resourcePolicy - The resource policy document, as provided in the PutResourcePolicyRequest.

PutResourcePolicyResponse, putResourcePolicyResponse_httpStatus - The response's http status code.

Response Lenses

putResourcePolicyResponse_resourcePolicy :: Lens' PutResourcePolicyResponse (Maybe ResourcePolicy) Source #

The resource policy document, as provided in the PutResourcePolicyRequest.

putResourcePolicyResponse_httpStatus :: Lens' PutResourcePolicyResponse Int Source #

The response's http status code.