Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeGuruProfiler.PutPermission

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds permissions to a profiling group's resource-based policy that are provided using an action group. If a profiling group doesn't have a resource-based policy, one is created for it using the permissions in the action group and the roles and users in the principals parameter.

 <p> The one supported action group that can be added is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"> <code>PostAgentProfile</code> </a>. </p> <p> The first time you call <code>PutPermission</code> on a profiling group, do not specify a <code>revisionId</code> because it doesn't have a resource-based policy. Subsequent calls must provide a <code>revisionId</code> to specify which revision of the resource-based policy to add the permissions to. </p> <p> The response contains the profiling group's JSON-formatted resource policy. </p>

Creating a Request

data PutPermission Source #

The structure representing the putPermissionRequest.

See: newPutPermission smart constructor.

Constructors

PutPermission'

Fields

revisionId :: Maybe Text
A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId.
actionGroup :: ActionGroup
Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions.
principals :: NonEmpty Text
A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs.
profilingGroupName :: Text
The name of the profiling group to grant access to.

Instances

Instances details

Eq PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods (==) :: PutPermission -> PutPermission -> Bool # (/=) :: PutPermission -> PutPermission -> Bool #
Read PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods readsPrec :: Int -> ReadS PutPermission # readList :: ReadS [PutPermission] # readPrec :: ReadPrec PutPermission # readListPrec :: ReadPrec [PutPermission] #
Show PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods showsPrec :: Int -> PutPermission -> ShowS # show :: PutPermission -> String # showList :: [PutPermission] -> ShowS #
Generic PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Associated Types type Rep PutPermission :: Type -> Type # Methods from :: PutPermission -> Rep PutPermission x # to :: Rep PutPermission x -> PutPermission #
NFData PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods rnf :: PutPermission -> () #
Hashable PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods hashWithSalt :: Int -> PutPermission -> Int # hash :: PutPermission -> Int #
ToJSON PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods toJSON :: PutPermission -> Value # toEncoding :: PutPermission -> Encoding # toJSONList :: [PutPermission] -> Value # toEncodingList :: [PutPermission] -> Encoding #
AWSRequest PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Associated Types type AWSResponse PutPermission # Methods request :: PutPermission -> Request PutPermission # response :: MonadResource m => Logger -> Service -> Proxy PutPermission -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutPermission))) #
ToHeaders PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods toHeaders :: PutPermission -> [Header] #
ToPath PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods toPath :: PutPermission -> ByteString #
ToQuery PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods toQuery :: PutPermission -> QueryString #
type Rep PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission type Rep PutPermission = D1 ('MetaData "PutPermission" "Amazonka.CodeGuruProfiler.PutPermission" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" 'False) (C1 ('MetaCons "PutPermission'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "revisionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "actionGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ActionGroup)) :: (S1 ('MetaSel ('Just "principals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "profilingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse PutPermission Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission type AWSResponse PutPermission = PutPermissionResponse

newPutPermission Source #

Arguments

:: ActionGroup	`$sel:actionGroup:PutPermission'`
-> NonEmpty Text	`$sel:principals:PutPermission'`
-> Text	`$sel:profilingGroupName:PutPermission'`
-> PutPermission

Create a value of PutPermission 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:revisionId:PutPermission', putPermission_revisionId - A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId.

$sel:actionGroup:PutPermission', putPermission_actionGroup - Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions.

$sel:principals:PutPermission', putPermission_principals - A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs.

$sel:profilingGroupName:PutPermission', putPermission_profilingGroupName - The name of the profiling group to grant access to.

Request Lenses

putPermission_revisionId :: Lens' PutPermission (Maybe Text) Source #

A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId.

putPermission_actionGroup :: Lens' PutPermission ActionGroup Source #

Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions.

putPermission_principals :: Lens' PutPermission (NonEmpty Text) Source #

A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs.

putPermission_profilingGroupName :: Lens' PutPermission Text Source #

The name of the profiling group to grant access to.

Destructuring the Response

data PutPermissionResponse Source #

The structure representing the putPermissionResponse.

See: newPutPermissionResponse smart constructor.

Constructors

PutPermissionResponse'
Fields httpStatus :: Int The response's http status code. policy :: Text The JSON-formatted resource-based policy on the profiling group that includes the added permissions. revisionId :: Text A universally unique identifier (UUID) for the revision of the resource-based policy that includes the added permissions. The JSON-formatted policy is in the `policy` element of the response.

Instances

Instances details

Eq PutPermissionResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods (==) :: PutPermissionResponse -> PutPermissionResponse -> Bool # (/=) :: PutPermissionResponse -> PutPermissionResponse -> Bool #
Read PutPermissionResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods readsPrec :: Int -> ReadS PutPermissionResponse # readList :: ReadS [PutPermissionResponse] # readPrec :: ReadPrec PutPermissionResponse # readListPrec :: ReadPrec [PutPermissionResponse] #
Show PutPermissionResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods showsPrec :: Int -> PutPermissionResponse -> ShowS # show :: PutPermissionResponse -> String # showList :: [PutPermissionResponse] -> ShowS #
Generic PutPermissionResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Associated Types type Rep PutPermissionResponse :: Type -> Type # Methods from :: PutPermissionResponse -> Rep PutPermissionResponse x # to :: Rep PutPermissionResponse x -> PutPermissionResponse #
NFData PutPermissionResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission Methods rnf :: PutPermissionResponse -> () #
type Rep PutPermissionResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.PutPermission type Rep PutPermissionResponse = D1 ('MetaData "PutPermissionResponse" "Amazonka.CodeGuruProfiler.PutPermission" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" 'False) (C1 ('MetaCons "PutPermissionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "revisionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutPermissionResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutPermissionResponse'`
-> Text	`$sel:policy:PutPermissionResponse'`
-> Text	`$sel:revisionId:PutPermission'`
-> PutPermissionResponse

Create a value of PutPermissionResponse 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:httpStatus:PutPermissionResponse', putPermissionResponse_httpStatus - The response's http status code.

$sel:policy:PutPermissionResponse', putPermissionResponse_policy - The JSON-formatted resource-based policy on the profiling group that includes the added permissions.

$sel:revisionId:PutPermission', putPermissionResponse_revisionId - A universally unique identifier (UUID) for the revision of the resource-based policy that includes the added permissions. The JSON-formatted policy is in the policy element of the response.

Response Lenses

putPermissionResponse_httpStatus :: Lens' PutPermissionResponse Int Source #

The response's http status code.

putPermissionResponse_policy :: Lens' PutPermissionResponse Text Source #

The JSON-formatted resource-based policy on the profiling group that includes the added permissions.

putPermissionResponse_revisionId :: Lens' PutPermissionResponse Text Source #

A universally unique identifier (UUID) for the revision of the resource-based policy that includes the added permissions. The JSON-formatted policy is in the policy element of the response.