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.SecretsManager.GetResourcePolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:GetResourcePolicy. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Creating a Request

data GetResourcePolicy Source #

See: newGetResourcePolicy smart constructor.

Constructors

GetResourcePolicy'
Fields secretId :: Text The ARN or name of the secret to retrieve the attached resource-based policy for. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Instances

Instances details

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

newGetResourcePolicy Source #

Arguments

:: Text	`$sel:secretId:GetResourcePolicy'`
-> GetResourcePolicy

Create a value of GetResourcePolicy 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:secretId:GetResourcePolicy', getResourcePolicy_secretId - The ARN or name of the secret to retrieve the attached resource-based policy for.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Request Lenses

getResourcePolicy_secretId :: Lens' GetResourcePolicy Text Source #

The ARN or name of the secret to retrieve the attached resource-based policy for.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Destructuring the Response

data GetResourcePolicyResponse Source #

See: newGetResourcePolicyResponse smart constructor.

Constructors

GetResourcePolicyResponse'

Fields

arn :: Maybe Text
The ARN of the secret that the resource-based policy was retrieved for.
name :: Maybe Text
The name of the secret that the resource-based policy was retrieved for.
resourcePolicy :: Maybe Text
A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetResourcePolicyResponse Source #

Arguments

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

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

GetResourcePolicyResponse, getResourcePolicyResponse_arn - The ARN of the secret that the resource-based policy was retrieved for.

GetResourcePolicyResponse, getResourcePolicyResponse_name - The name of the secret that the resource-based policy was retrieved for.

$sel:resourcePolicy:GetResourcePolicyResponse', getResourcePolicyResponse_resourcePolicy - A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.

$sel:httpStatus:GetResourcePolicyResponse', getResourcePolicyResponse_httpStatus - The response's http status code.

Response Lenses

getResourcePolicyResponse_arn :: Lens' GetResourcePolicyResponse (Maybe Text) Source #

The ARN of the secret that the resource-based policy was retrieved for.

getResourcePolicyResponse_name :: Lens' GetResourcePolicyResponse (Maybe Text) Source #

The name of the secret that the resource-based policy was retrieved for.

getResourcePolicyResponse_resourcePolicy :: Lens' GetResourcePolicyResponse (Maybe Text) Source #

A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.

getResourcePolicyResponse_httpStatus :: Lens' GetResourcePolicyResponse Int Source #

The response's http status code.