libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler
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.CodeGuruProfiler.ConfigureAgent

Description

Used by profiler agents to report their current state and to receive remote configuration updates. For example, ConfigureAgent can be used to tell an agent whether to profile or not and for how long to return profiling data.

Synopsis

Creating a Request

data ConfigureAgent Source #

The structure representing the configureAgentRequest.

See: newConfigureAgent smart constructor.

Constructors

ConfigureAgent' 

Fields

  • fleetInstanceId :: Maybe Text

    A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID.

  • metadata :: Maybe (HashMap MetadataField Text)

    Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

    • COMPUTE_PLATFORM - The compute platform on which the agent is running
    • AGENT_ID - The ID for an agent instance.
    • AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.
    • EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.
    • LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.
    • LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.
    • LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.
    • LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.
    • LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.
  • profilingGroupName :: Text

    The name of the profiling group for which the configured agent is collecting profiling data.

Instances

Instances details
Eq ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

(==) :: ConfigureAgent -> ConfigureAgent -> Bool #

(/=) :: ConfigureAgent -> ConfigureAgent -> Bool #

Read ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

readsPrec :: Int -> ReadS ConfigureAgent #

readList :: ReadS [ConfigureAgent] #

readPrec :: ReadPrec ConfigureAgent #

readListPrec :: ReadPrec [ConfigureAgent] #

Show ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

showsPrec :: Int -> ConfigureAgent -> ShowS #

show :: ConfigureAgent -> String #

showList :: [ConfigureAgent] -> ShowS #

Generic ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Associated Types

type Rep ConfigureAgent :: Type -> Type #

Methods

from :: ConfigureAgent -> Rep ConfigureAgent x #

to :: Rep ConfigureAgent x -> ConfigureAgent #

NFData ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

rnf :: ConfigureAgent -> () #

Hashable ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

hashWithSalt :: Int -> ConfigureAgent -> Int #

hash :: ConfigureAgent -> Int #

ToJSON ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

toJSON :: ConfigureAgent -> Value #

toEncoding :: ConfigureAgent -> Encoding #

toJSONList :: [ConfigureAgent] -> Value #

toEncodingList :: [ConfigureAgent] -> Encoding #

AWSRequest ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Associated Types

type AWSResponse ConfigureAgent #

Methods

request :: ConfigureAgent -> Request ConfigureAgent #

response :: MonadResource m => Logger -> Service -> Proxy ConfigureAgent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ConfigureAgent))) #

ToHeaders ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

toHeaders :: ConfigureAgent -> [Header] #

ToPath ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

toPath :: ConfigureAgent -> ByteString #

ToQuery ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

toQuery :: ConfigureAgent -> QueryString #

type Rep ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

type Rep ConfigureAgent = D1 ('MetaData "ConfigureAgent" "Amazonka.CodeGuruProfiler.ConfigureAgent" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" 'False) (C1 ('MetaCons "ConfigureAgent'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetInstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap MetadataField Text))) :*: S1 ('MetaSel ('Just "profilingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ConfigureAgent Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

type AWSResponse ConfigureAgent = ConfigureAgentResponse

newConfigureAgent Source #

Arguments

:: Text

$sel:profilingGroupName:ConfigureAgent'

-> ConfigureAgent 

Create a value of ConfigureAgent 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:fleetInstanceId:ConfigureAgent', configureAgent_fleetInstanceId - A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID.

$sel:metadata:ConfigureAgent', configureAgent_metadata - Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

  • COMPUTE_PLATFORM - The compute platform on which the agent is running
  • AGENT_ID - The ID for an agent instance.
  • AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.
  • EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.
  • LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.
  • LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.
  • LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.
  • LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.
  • LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.

$sel:profilingGroupName:ConfigureAgent', configureAgent_profilingGroupName - The name of the profiling group for which the configured agent is collecting profiling data.

Request Lenses

configureAgent_fleetInstanceId :: Lens' ConfigureAgent (Maybe Text) Source #

A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID.

configureAgent_metadata :: Lens' ConfigureAgent (Maybe (HashMap MetadataField Text)) Source #

Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

  • COMPUTE_PLATFORM - The compute platform on which the agent is running
  • AGENT_ID - The ID for an agent instance.
  • AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.
  • EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.
  • LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.
  • LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.
  • LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.
  • LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.
  • LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.

configureAgent_profilingGroupName :: Lens' ConfigureAgent Text Source #

The name of the profiling group for which the configured agent is collecting profiling data.

Destructuring the Response

data ConfigureAgentResponse Source #

The structure representing the configureAgentResponse.

See: newConfigureAgentResponse smart constructor.

Constructors

ConfigureAgentResponse' 

Fields

Instances

Instances details
Eq ConfigureAgentResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

(==) :: ConfigureAgentResponse -> ConfigureAgentResponse -> Bool #

(/=) :: ConfigureAgentResponse -> ConfigureAgentResponse -> Bool #

Read ConfigureAgentResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

readsPrec :: Int -> ReadS ConfigureAgentResponse #

readList :: ReadS [ConfigureAgentResponse] #

readPrec :: ReadPrec ConfigureAgentResponse #

readListPrec :: ReadPrec [ConfigureAgentResponse] #

Show ConfigureAgentResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

showsPrec :: Int -> ConfigureAgentResponse -> ShowS #

show :: ConfigureAgentResponse -> String #

showList :: [ConfigureAgentResponse] -> ShowS #

Generic ConfigureAgentResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Associated Types

type Rep ConfigureAgentResponse :: Type -> Type #

Methods

from :: ConfigureAgentResponse -> Rep ConfigureAgentResponse x #

to :: Rep ConfigureAgentResponse x -> ConfigureAgentResponse #

NFData ConfigureAgentResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

Methods

rnf :: ConfigureAgentResponse -> () #

type Rep ConfigureAgentResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ConfigureAgent

type Rep ConfigureAgentResponse = D1 ('MetaData "ConfigureAgentResponse" "Amazonka.CodeGuruProfiler.ConfigureAgent" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" 'False) (C1 ('MetaCons "ConfigureAgentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AgentConfiguration)))

newConfigureAgentResponse Source #

Arguments

:: Int

$sel:httpStatus:ConfigureAgentResponse'

-> AgentConfiguration

$sel:configuration:ConfigureAgentResponse'

-> ConfigureAgentResponse 

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

$sel:configuration:ConfigureAgentResponse', configureAgentResponse_configuration - An AgentConfiguration object that specifies if an agent profiles or not and for how long to return profiling data.

Response Lenses

configureAgentResponse_httpStatus :: Lens' ConfigureAgentResponse Int Source #

The response's http status code.

configureAgentResponse_configuration :: Lens' ConfigureAgentResponse AgentConfiguration Source #

An AgentConfiguration object that specifies if an agent profiles or not and for how long to return profiling data.