[ aws . codeguruprofiler ]

create-profiling-group

Description

Creates a profiling group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-profiling-group
[--agent-orchestration-config <value>]
[--client-token <value>]
[--compute-platform <value>]
--profiling-group-name <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--agent-orchestration-config (structure)

Specifies whether profiling is enabled or disabled for the created profiling group.

profilingEnabled -> (boolean)

A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

Shorthand Syntax:

profilingEnabled=boolean

JSON Syntax:

{
  "profilingEnabled": true|false
}

--client-token (string)

Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental creation of duplicate profiling groups if there are failures and retries.

--compute-platform (string)

The compute platform of the profiling group. Use AWSLambda if your application runs on AWS Lambda. Use Default if your application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, Default is used.

Possible values:

• AWSLambda

• Default

--profiling-group-name (string)

The name of the profiling group to create.

--tags (map)

A list of tags to add to the created profiling group.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

profilingGroup -> (structure)

The returned ` ProfilingGroupDescription https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html`__ object that contains information about the created profiling group.

agentOrchestrationConfig -> (structure)

An ` AgentOrchestrationConfig https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentOrchestrationConfig.html`__ object that indicates if the profiling group is enabled for profiled or not.

profilingEnabled -> (boolean)

A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

arn -> (string)

The Amazon Resource Name (ARN) identifying the profiling group resource.

computePlatform -> (string)

The compute platform of the profiling group. If it is set to AWSLambda , then the profiled application runs on AWS Lambda. If it is set to Default , then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is Default .

createdAt -> (timestamp)

The time when the profiling group was created. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

name -> (string)

The name of the profiling group.

profilingStatus -> (structure)

A ` ProfilingStatus https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingStatus.html`__ object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.

latestAgentOrchestratedAt -> (timestamp)

The date and time when the profiling agent most recently pinged back. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

latestAgentProfileReportedAt -> (timestamp)

The date and time when the most recent profile was received. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

latestAggregatedProfile -> (structure)

An ` AggregatedProfileTime https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html`__ object that contains the aggregation period and start time for an aggregated profile.

period -> (string)

The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format.

• P1D — 1 day

• PT1H — 1 hour

• PT5M — 5 minutes

start -> (timestamp)

The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the period property of the AggregatedProfileTime object.

Specify start using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

tags -> (map)

A list of the tags that belong to this profiling group.

key -> (string)

value -> (string)

updatedAt -> (timestamp)

The date and time when the profiling group was last updated. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.