aws-sdk-codeguruprofiler 1.0.0 → 1.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b4cc53085da17ec46155faa92032692f067449ff
4
- data.tar.gz: 46670705aea14a16a79fcbf4b1b076367011a11e
3
+ metadata.gz: 6c4c016b104cf7e179d480158752de359df1a190
4
+ data.tar.gz: 3895b720baf17140facded72da3a25ab7d95a791
5
5
  SHA512:
6
- metadata.gz: 8271046afc4f8249a7ab5fd0a539bf5d5b059a217ec7a753f358d8bc15427c6e1b31d81fabdb3a5ee1209b349643293e6e3036e60c3143f97dab944c6e9487d4
7
- data.tar.gz: 3d470dc7efe5e63eb77502f98308f40274951c739d59fcddf6abaf824c55ae999c3d79d71e1ce0629ca7260ff2d668bd94323a23cf1afbef216cd6637203ff07
6
+ metadata.gz: 8ed0062d957162412b397c22dc6c3681f492dd8f64710d128145554545a0f67fa873b7867189ec7da60ee863b1342d20206e0f61d2e0f2cfaddfed07f69dd138
7
+ data.tar.gz: 8ce55e5f39ca4fc1c84e98c037f0771122b7499223ad9ebd9eeb6fa454f30953d1fc889d2cd667d2e1fb02c5696bd6981494c2a683ac4a64e1e722675f5f2367
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-codeguruprofiler/customizations'
42
42
  # @service
43
43
  module Aws::CodeGuruProfiler
44
44
 
45
- GEM_VERSION = '1.0.0'
45
+ GEM_VERSION = '1.1.1'
46
46
 
47
47
  end
@@ -254,15 +254,9 @@ module Aws::CodeGuruProfiler
254
254
 
255
255
  # @!group API Operations
256
256
 
257
- # Provides the configuration to use for an agent of the profiling group.
258
- #
259
257
  # @option params [String] :fleet_instance_id
260
- # Identifier of the instance of compute fleet being profiled by the
261
- # agent. For instance, host name in EC2, task id for ECS, function name
262
- # for AWS Lambda
263
258
  #
264
259
  # @option params [required, String] :profiling_group_name
265
- # The name of the profiling group.
266
260
  #
267
261
  # @return [Types::ConfigureAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
268
262
  #
@@ -289,15 +283,17 @@ module Aws::CodeGuruProfiler
289
283
  req.send_request(options)
290
284
  end
291
285
 
292
- # Create a profiling group.
286
+ # Creates a profiling group.
293
287
  #
294
288
  # @option params [Types::AgentOrchestrationConfig] :agent_orchestration_config
295
- # Configuration to orchestrate agents to create and report agent
296
- # profiles of the profiling group. Agents are orchestrated if they
297
- # follow the agent orchestration protocol.
289
+ # The agent orchestration configuration.
298
290
  #
299
291
  # @option params [required, String] :client_token
300
- # Client token for the request.
292
+ # Unique, case-sensitive identifier that you provide to ensure the
293
+ # idempotency of the request.
294
+ #
295
+ # This parameter specifies a unique identifier for the new profiling
296
+ # group that helps ensure idempotency.
301
297
  #
302
298
  # **A suitable default value is auto-generated.** You should normally
303
299
  # not need to pass this option.**
@@ -340,10 +336,10 @@ module Aws::CodeGuruProfiler
340
336
  req.send_request(options)
341
337
  end
342
338
 
343
- # Delete a profiling group.
339
+ # Deletes a profiling group.
344
340
  #
345
341
  # @option params [required, String] :profiling_group_name
346
- # The name of the profiling group.
342
+ # The profiling group name to delete.
347
343
  #
348
344
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
349
345
  #
@@ -362,10 +358,10 @@ module Aws::CodeGuruProfiler
362
358
  req.send_request(options)
363
359
  end
364
360
 
365
- # Describe a profiling group.
361
+ # Describes a profiling group.
366
362
  #
367
363
  # @option params [required, String] :profiling_group_name
368
- # The name of the profiling group.
364
+ # The profiling group name.
369
365
  #
370
366
  # @return [Types::DescribeProfilingGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
371
367
  #
@@ -398,38 +394,47 @@ module Aws::CodeGuruProfiler
398
394
  req.send_request(options)
399
395
  end
400
396
 
401
- # Get the aggregated profile of a profiling group for the specified time
402
- # range. If the requested time range does not align with the available
403
- # aggregated profiles, it will be expanded to attain alignment. If
397
+ # Gets the aggregated profile of a profiling group for the specified
398
+ # time range. If the requested time range does not align with the
399
+ # available aggregated profiles, it is expanded to attain alignment. If
404
400
  # aggregated profiles are available only for part of the period
405
401
  # requested, the profile is returned from the earliest available to the
406
- # latest within the requested time range. For instance, if the requested
407
- # time range is from 00:00 to 00:20 and the available profiles are from
408
- # 00:15 to 00:25, then the returned profile will be from 00:15 to 00:20.
402
+ # latest within the requested time range.
403
+ #
404
+ # For example, if the requested time range is from 00:00 to 00:20 and
405
+ # the available profiles are from 00:15 to 00:25, the returned profile
406
+ # will be from 00:15 to 00:20.
407
+ #
408
+ # You must specify exactly two of the following parameters: `startTime`,
409
+ # `period`, and `endTime`.
409
410
  #
410
411
  # @option params [String] :accept
411
- # The format of the profile to return. Supports application/json or
412
- # application/x-amzn-ion. Defaults to application/x-amzn-ion.
412
+ # The format of the profile to return. You can choose `application/json`
413
+ # or the default `application/x-amzn-ion`.
413
414
  #
414
415
  # @option params [Time,DateTime,Date,Integer,String] :end_time
415
- # The end time of the profile to get. Either period or endTime must be
416
- # specified. Must be greater than start and the overall time range to be
417
- # in the past and not larger than a week.
416
+ # You must specify exactly two of the following parameters: `startTime`,
417
+ # `period`, and `endTime`.
418
418
  #
419
419
  # @option params [Integer] :max_depth
420
- # Limit the max depth of the profile.
420
+ # The maximum depth of the graph.
421
421
  #
422
422
  # @option params [String] :period
423
- # The period of the profile to get. Exactly two of `startTime`, `period`
424
- # and `endTime` must be specified. Must be positive and the overall time
425
- # range to be in the past and not larger than a week.
423
+ # The period of the profile to get. The time range must be in the past
424
+ # and not longer than one week.
425
+ #
426
+ # You must specify exactly two of the following parameters: `startTime`,
427
+ # `period`, and `endTime`.
426
428
  #
427
429
  # @option params [required, String] :profiling_group_name
428
- # The name of the profiling group.
430
+ # The name of the profiling group to get.
429
431
  #
430
432
  # @option params [Time,DateTime,Date,Integer,String] :start_time
431
433
  # The start time of the profile to get.
432
434
  #
435
+ # You must specify exactly two of the following parameters: `startTime`,
436
+ # `period`, and `endTime`.
437
+ #
433
438
  # @return [Types::GetProfileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
434
439
  #
435
440
  # * {Types::GetProfileResponse#content_encoding #content_encoding} => String
@@ -467,26 +472,40 @@ module Aws::CodeGuruProfiler
467
472
  # range.
468
473
  #
469
474
  # @option params [required, Time,DateTime,Date,Integer,String] :end_time
470
- # The end time of the time range to list profiles until.
475
+ # The end time of the time range from which to list the profiles.
471
476
  #
472
477
  # @option params [Integer] :max_results
473
- # Upper bound on the number of results to list in a single call.
478
+ # The maximum number of profile time results returned by
479
+ # `ListProfileTimes` in paginated output. When this parameter is used,
480
+ # `ListProfileTimes` only returns `maxResults` results in a single page
481
+ # with a `nextToken` response element. The remaining results of the
482
+ # initial request can be seen by sending another `ListProfileTimes`
483
+ # request with the returned `nextToken` value.
474
484
  #
475
485
  # @option params [String] :next_token
476
- # Token for paginating results.
486
+ # The `nextToken` value returned from a previous paginated
487
+ # `ListProfileTimes` request where `maxResults` was used and the results
488
+ # exceeded the value of that parameter. Pagination continues from the
489
+ # end of the previous results that returned the `nextToken` value.
490
+ #
491
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only used
492
+ # to retrieve the next items in a list and not for other programmatic
493
+ # purposes.
494
+ #
495
+ # </note>
477
496
  #
478
497
  # @option params [String] :order_by
479
498
  # The order (ascending or descending by start time of the profile) to
480
- # list the profiles by. Defaults to TIMESTAMP\_DESCENDING.
499
+ # use when listing profiles. Defaults to `TIMESTAMP_DESCENDING`.
481
500
  #
482
501
  # @option params [required, String] :period
483
- # The aggregation period to list the profiles for.
502
+ # The aggregation period.
484
503
  #
485
504
  # @option params [required, String] :profiling_group_name
486
505
  # The name of the profiling group.
487
506
  #
488
507
  # @option params [required, Time,DateTime,Date,Integer,String] :start_time
489
- # The start time of the time range to list the profiles from.
508
+ # The start time of the time range from which to list the profiles.
490
509
  #
491
510
  # @return [Types::ListProfileTimesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
492
511
  #
@@ -520,17 +539,31 @@ module Aws::CodeGuruProfiler
520
539
  req.send_request(options)
521
540
  end
522
541
 
523
- # List profiling groups in the account.
542
+ # Lists profiling groups.
524
543
  #
525
544
  # @option params [Boolean] :include_description
526
- # If set to true, returns the full description of the profiling groups
527
- # instead of the names. Defaults to false.
545
+ # A Boolean value indicating whether to include a description.
528
546
  #
529
547
  # @option params [Integer] :max_results
530
- # Upper bound on the number of results to list in a single call.
548
+ # The maximum number of profiling groups results returned by
549
+ # `ListProfilingGroups` in paginated output. When this parameter is
550
+ # used, `ListProfilingGroups` only returns `maxResults` results in a
551
+ # single page along with a `nextToken` response element. The remaining
552
+ # results of the initial request can be seen by sending another
553
+ # `ListProfilingGroups` request with the returned `nextToken` value.
531
554
  #
532
555
  # @option params [String] :next_token
533
- # Token for paginating results.
556
+ # The `nextToken` value returned from a previous paginated
557
+ # `ListProfilingGroups` request where `maxResults` was used and the
558
+ # results exceeded the value of that parameter. Pagination continues
559
+ # from the end of the previous results that returned the `nextToken`
560
+ # value.
561
+ #
562
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only used
563
+ # to retrieve the next items in a list and not for other programmatic
564
+ # purposes.
565
+ #
566
+ # </note>
534
567
  #
535
568
  # @return [Types::ListProfilingGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
536
569
  #
@@ -571,27 +604,15 @@ module Aws::CodeGuruProfiler
571
604
  req.send_request(options)
572
605
  end
573
606
 
574
- # Submit profile collected by an agent belonging to a profiling group
575
- # for aggregation.
576
- #
577
607
  # @option params [required, String, IO] :agent_profile
578
- # The profile collected by an agent for a time range.
579
608
  #
580
609
  # @option params [required, String] :content_type
581
- # The content type of the agent profile in the payload. Recommended to
582
- # send the profile gzipped with content-type application/octet-stream.
583
- # Other accepted values are application/x-amzn-ion and application/json
584
- # for unzipped Ion and JSON respectively.
585
610
  #
586
611
  # @option params [String] :profile_token
587
- # Client generated token to deduplicate the agent profile during
588
- # aggregation.
589
- #
590
612
  # **A suitable default value is auto-generated.** You should normally
591
613
  # not need to pass this option.**
592
614
  #
593
615
  # @option params [required, String] :profiling_group_name
594
- # The name of the profiling group.
595
616
  #
596
617
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
597
618
  #
@@ -613,13 +634,12 @@ module Aws::CodeGuruProfiler
613
634
  req.send_request(options)
614
635
  end
615
636
 
616
- # Update a profiling group.
637
+ # Updates a profiling group.
617
638
  #
618
639
  # @option params [required, Types::AgentOrchestrationConfig] :agent_orchestration_config
619
- # Remote configuration to configure the agents of the profiling group.
620
640
  #
621
641
  # @option params [required, String] :profiling_group_name
622
- # The name of the profiling group.
642
+ # The name of the profiling group to update.
623
643
  #
624
644
  # @return [Types::UpdateProfilingGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
625
645
  #
@@ -668,7 +688,7 @@ module Aws::CodeGuruProfiler
668
688
  params: params,
669
689
  config: config)
670
690
  context[:gem_name] = 'aws-sdk-codeguruprofiler'
671
- context[:gem_version] = '1.0.0'
691
+ context[:gem_version] = '1.1.1'
672
692
  Seahorse::Client::Request.new(handlers, context)
673
693
  end
674
694
 
@@ -8,15 +8,10 @@
8
8
  module Aws::CodeGuruProfiler
9
9
  module Types
10
10
 
11
- # The configuration for the agent to use.
12
- #
13
11
  # @!attribute [rw] period_in_seconds
14
- # Specifies the period to follow the configuration (to profile or not)
15
- # and call back to get a new configuration.
16
12
  # @return [Integer]
17
13
  #
18
14
  # @!attribute [rw] should_profile
19
- # Specifies if the profiling should be enabled by the agent.
20
15
  # @return [Boolean]
21
16
  #
22
17
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/AgentConfiguration AWS API Documentation
@@ -27,10 +22,6 @@ module Aws::CodeGuruProfiler
27
22
  include Aws::Structure
28
23
  end
29
24
 
30
- # Configuration to orchestrate agents to create and report agent
31
- # profiles of the profiling group. Agents are orchestrated if they
32
- # follow the agent orchestration protocol.
33
- #
34
25
  # @note When making an API call, you may pass AgentOrchestrationConfig
35
26
  # data as a hash:
36
27
  #
@@ -39,7 +30,6 @@ module Aws::CodeGuruProfiler
39
30
  # }
40
31
  #
41
32
  # @!attribute [rw] profiling_enabled
42
- # If the agents should be enabled to create and report profiles.
43
33
  # @return [Boolean]
44
34
  #
45
35
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/AgentOrchestrationConfig AWS API Documentation
@@ -49,14 +39,15 @@ module Aws::CodeGuruProfiler
49
39
  include Aws::Structure
50
40
  end
51
41
 
52
- # The time range of an aggregated profile.
42
+ # Information about the time range of the latest available aggregated
43
+ # profile.
53
44
  #
54
45
  # @!attribute [rw] period
55
- # The aggregation period of the aggregated profile.
46
+ # The time period.
56
47
  # @return [String]
57
48
  #
58
49
  # @!attribute [rw] start
59
- # The start time of the aggregated profile.
50
+ # The start time.
60
51
  # @return [Time]
61
52
  #
62
53
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/AggregatedProfileTime AWS API Documentation
@@ -67,7 +58,7 @@ module Aws::CodeGuruProfiler
67
58
  include Aws::Structure
68
59
  end
69
60
 
70
- # Request for ConfigureAgent operation.
61
+ # The structure representing the configureAgentRequest.
71
62
  #
72
63
  # @note When making an API call, you may pass ConfigureAgentRequest
73
64
  # data as a hash:
@@ -78,13 +69,9 @@ module Aws::CodeGuruProfiler
78
69
  # }
79
70
  #
80
71
  # @!attribute [rw] fleet_instance_id
81
- # Identifier of the instance of compute fleet being profiled by the
82
- # agent. For instance, host name in EC2, task id for ECS, function
83
- # name for AWS Lambda
84
72
  # @return [String]
85
73
  #
86
74
  # @!attribute [rw] profiling_group_name
87
- # The name of the profiling group.
88
75
  # @return [String]
89
76
  #
90
77
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ConfigureAgentRequest AWS API Documentation
@@ -95,10 +82,9 @@ module Aws::CodeGuruProfiler
95
82
  include Aws::Structure
96
83
  end
97
84
 
98
- # Response for ConfigureAgent operation.
85
+ # The structure representing the configureAgentResponse.
99
86
  #
100
87
  # @!attribute [rw] configuration
101
- # The configuration for the agent to use.
102
88
  # @return [Types::AgentConfiguration]
103
89
  #
104
90
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ConfigureAgentResponse AWS API Documentation
@@ -108,7 +94,9 @@ module Aws::CodeGuruProfiler
108
94
  include Aws::Structure
109
95
  end
110
96
 
111
- # Request can can cause an inconsistent state for the resource.
97
+ # The requested operation would cause a conflict with the current state
98
+ # of a service resource associated with the request. Resolve the
99
+ # conflict before retrying this request.
112
100
  #
113
101
  # @!attribute [rw] message
114
102
  # @return [String]
@@ -120,7 +108,7 @@ module Aws::CodeGuruProfiler
120
108
  include Aws::Structure
121
109
  end
122
110
 
123
- # Request for CreateProfilingGroup operation.
111
+ # The structure representing the createProfiliingGroupRequest.
124
112
  #
125
113
  # @note When making an API call, you may pass CreateProfilingGroupRequest
126
114
  # data as a hash:
@@ -134,13 +122,15 @@ module Aws::CodeGuruProfiler
134
122
  # }
135
123
  #
136
124
  # @!attribute [rw] agent_orchestration_config
137
- # Configuration to orchestrate agents to create and report agent
138
- # profiles of the profiling group. Agents are orchestrated if they
139
- # follow the agent orchestration protocol.
125
+ # The agent orchestration configuration.
140
126
  # @return [Types::AgentOrchestrationConfig]
141
127
  #
142
128
  # @!attribute [rw] client_token
143
- # Client token for the request.
129
+ # Unique, case-sensitive identifier that you provide to ensure the
130
+ # idempotency of the request.
131
+ #
132
+ # This parameter specifies a unique identifier for the new profiling
133
+ # group that helps ensure idempotency.
144
134
  #
145
135
  # **A suitable default value is auto-generated.** You should normally
146
136
  # not need to pass this option.
@@ -159,10 +149,10 @@ module Aws::CodeGuruProfiler
159
149
  include Aws::Structure
160
150
  end
161
151
 
162
- # Response for CreateProfilingGroup operation.
152
+ # The structure representing the createProfilingGroupResponse.
163
153
  #
164
154
  # @!attribute [rw] profiling_group
165
- # The description of a profiling group.
155
+ # Information about the new profiling group
166
156
  # @return [Types::ProfilingGroupDescription]
167
157
  #
168
158
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/CreateProfilingGroupResponse AWS API Documentation
@@ -172,7 +162,7 @@ module Aws::CodeGuruProfiler
172
162
  include Aws::Structure
173
163
  end
174
164
 
175
- # Request for DeleteProfilingGroup operation.
165
+ # The structure representing the deleteProfilingGroupRequest.
176
166
  #
177
167
  # @note When making an API call, you may pass DeleteProfilingGroupRequest
178
168
  # data as a hash:
@@ -182,7 +172,7 @@ module Aws::CodeGuruProfiler
182
172
  # }
183
173
  #
184
174
  # @!attribute [rw] profiling_group_name
185
- # The name of the profiling group.
175
+ # The profiling group name to delete.
186
176
  # @return [String]
187
177
  #
188
178
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/DeleteProfilingGroupRequest AWS API Documentation
@@ -192,13 +182,13 @@ module Aws::CodeGuruProfiler
192
182
  include Aws::Structure
193
183
  end
194
184
 
195
- # Response for DeleteProfilingGroup operation.
185
+ # The structure representing the deleteProfilingGroupResponse.
196
186
  #
197
187
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/DeleteProfilingGroupResponse AWS API Documentation
198
188
  #
199
189
  class DeleteProfilingGroupResponse < Aws::EmptyStructure; end
200
190
 
201
- # Request for DescribeProfilingGroup operation.
191
+ # The structure representing the describeProfilingGroupRequest.
202
192
  #
203
193
  # @note When making an API call, you may pass DescribeProfilingGroupRequest
204
194
  # data as a hash:
@@ -208,7 +198,7 @@ module Aws::CodeGuruProfiler
208
198
  # }
209
199
  #
210
200
  # @!attribute [rw] profiling_group_name
211
- # The name of the profiling group.
201
+ # The profiling group name.
212
202
  # @return [String]
213
203
  #
214
204
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/DescribeProfilingGroupRequest AWS API Documentation
@@ -218,10 +208,10 @@ module Aws::CodeGuruProfiler
218
208
  include Aws::Structure
219
209
  end
220
210
 
221
- # Response for DescribeProfilingGroup operation.
211
+ # The structure representing the describeProfilingGroupResponse.
222
212
  #
223
213
  # @!attribute [rw] profiling_group
224
- # The description of a profiling group.
214
+ # Information about a profiling group.
225
215
  # @return [Types::ProfilingGroupDescription]
226
216
  #
227
217
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/DescribeProfilingGroupResponse AWS API Documentation
@@ -231,7 +221,7 @@ module Aws::CodeGuruProfiler
231
221
  include Aws::Structure
232
222
  end
233
223
 
234
- # Request for GetProfile operation.
224
+ # The structure representing the getProfileRequest.
235
225
  #
236
226
  # @note When making an API call, you may pass GetProfileRequest
237
227
  # data as a hash:
@@ -246,32 +236,36 @@ module Aws::CodeGuruProfiler
246
236
  # }
247
237
  #
248
238
  # @!attribute [rw] accept
249
- # The format of the profile to return. Supports application/json or
250
- # application/x-amzn-ion. Defaults to application/x-amzn-ion.
239
+ # The format of the profile to return. You can choose
240
+ # `application/json` or the default `application/x-amzn-ion`.
251
241
  # @return [String]
252
242
  #
253
243
  # @!attribute [rw] end_time
254
- # The end time of the profile to get. Either period or endTime must be
255
- # specified. Must be greater than start and the overall time range to
256
- # be in the past and not larger than a week.
244
+ # You must specify exactly two of the following parameters:
245
+ # `startTime`, `period`, and `endTime`.
257
246
  # @return [Time]
258
247
  #
259
248
  # @!attribute [rw] max_depth
260
- # Limit the max depth of the profile.
249
+ # The maximum depth of the graph.
261
250
  # @return [Integer]
262
251
  #
263
252
  # @!attribute [rw] period
264
- # The period of the profile to get. Exactly two of `startTime`,
265
- # `period` and `endTime` must be specified. Must be positive and the
266
- # overall time range to be in the past and not larger than a week.
253
+ # The period of the profile to get. The time range must be in the past
254
+ # and not longer than one week.
255
+ #
256
+ # You must specify exactly two of the following parameters:
257
+ # `startTime`, `period`, and `endTime`.
267
258
  # @return [String]
268
259
  #
269
260
  # @!attribute [rw] profiling_group_name
270
- # The name of the profiling group.
261
+ # The name of the profiling group to get.
271
262
  # @return [String]
272
263
  #
273
264
  # @!attribute [rw] start_time
274
265
  # The start time of the profile to get.
266
+ #
267
+ # You must specify exactly two of the following parameters:
268
+ # `startTime`, `period`, and `endTime`.
275
269
  # @return [Time]
276
270
  #
277
271
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/GetProfileRequest AWS API Documentation
@@ -286,21 +280,19 @@ module Aws::CodeGuruProfiler
286
280
  include Aws::Structure
287
281
  end
288
282
 
289
- # Response for GetProfile operation.
283
+ # The structure representing the getProfileResponse.
290
284
  #
291
285
  # @!attribute [rw] content_encoding
292
- # The content encoding of the profile in the payload.
286
+ # The content encoding of the profile.
293
287
  # @return [String]
294
288
  #
295
289
  # @!attribute [rw] content_type
296
- # The content type of the profile in the payload. Will be
297
- # application/json or application/x-amzn-ion based on Accept header in
298
- # the request.
290
+ # The content type of the profile in the payload. It is either
291
+ # `application/json` or the default `application/x-amzn-ion`.
299
292
  # @return [String]
300
293
  #
301
294
  # @!attribute [rw] profile
302
- # The profile representing the aggregation of agent profiles of the
303
- # profiling group for a time range.
295
+ # Information about the profile.
304
296
  # @return [String]
305
297
  #
306
298
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/GetProfileResponse AWS API Documentation
@@ -312,7 +304,8 @@ module Aws::CodeGuruProfiler
312
304
  include Aws::Structure
313
305
  end
314
306
 
315
- # Unexpected error during processing of request.
307
+ # The server encountered an internal error and is unable to complete the
308
+ # request.
316
309
  #
317
310
  # @!attribute [rw] message
318
311
  # @return [String]
@@ -324,7 +317,7 @@ module Aws::CodeGuruProfiler
324
317
  include Aws::Structure
325
318
  end
326
319
 
327
- # Request for ListProfileTimes operation.
320
+ # The structure representing the listProfileTimesRequest.
328
321
  #
329
322
  # @note When making an API call, you may pass ListProfileTimesRequest
330
323
  # data as a hash:
@@ -340,24 +333,39 @@ module Aws::CodeGuruProfiler
340
333
  # }
341
334
  #
342
335
  # @!attribute [rw] end_time
343
- # The end time of the time range to list profiles until.
336
+ # The end time of the time range from which to list the profiles.
344
337
  # @return [Time]
345
338
  #
346
339
  # @!attribute [rw] max_results
347
- # Upper bound on the number of results to list in a single call.
340
+ # The maximum number of profile time results returned by
341
+ # `ListProfileTimes` in paginated output. When this parameter is used,
342
+ # `ListProfileTimes` only returns `maxResults` results in a single
343
+ # page with a `nextToken` response element. The remaining results of
344
+ # the initial request can be seen by sending another
345
+ # `ListProfileTimes` request with the returned `nextToken` value.
348
346
  # @return [Integer]
349
347
  #
350
348
  # @!attribute [rw] next_token
351
- # Token for paginating results.
349
+ # The `nextToken` value returned from a previous paginated
350
+ # `ListProfileTimes` request where `maxResults` was used and the
351
+ # results exceeded the value of that parameter. Pagination continues
352
+ # from the end of the previous results that returned the `nextToken`
353
+ # value.
354
+ #
355
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only
356
+ # used to retrieve the next items in a list and not for other
357
+ # programmatic purposes.
358
+ #
359
+ # </note>
352
360
  # @return [String]
353
361
  #
354
362
  # @!attribute [rw] order_by
355
363
  # The order (ascending or descending by start time of the profile) to
356
- # list the profiles by. Defaults to TIMESTAMP\_DESCENDING.
364
+ # use when listing profiles. Defaults to `TIMESTAMP_DESCENDING`.
357
365
  # @return [String]
358
366
  #
359
367
  # @!attribute [rw] period
360
- # The aggregation period to list the profiles for.
368
+ # The aggregation period.
361
369
  # @return [String]
362
370
  #
363
371
  # @!attribute [rw] profiling_group_name
@@ -365,7 +373,7 @@ module Aws::CodeGuruProfiler
365
373
  # @return [String]
366
374
  #
367
375
  # @!attribute [rw] start_time
368
- # The start time of the time range to list the profiles from.
376
+ # The start time of the time range from which to list the profiles.
369
377
  # @return [Time]
370
378
  #
371
379
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ListProfileTimesRequest AWS API Documentation
@@ -381,15 +389,19 @@ module Aws::CodeGuruProfiler
381
389
  include Aws::Structure
382
390
  end
383
391
 
384
- # Response for ListProfileTimes operation.
392
+ # The structure representing the listProfileTimesResponse.
385
393
  #
386
394
  # @!attribute [rw] next_token
387
- # Token for paginating results.
395
+ # The `nextToken` value to include in a future `ListProfileTimes`
396
+ # request. When the results of a `ListProfileTimes` request exceed
397
+ # `maxResults`, this value can be used to retrieve the next page of
398
+ # results. This value is `null` when there are no more results to
399
+ # return.
388
400
  # @return [String]
389
401
  #
390
402
  # @!attribute [rw] profile_times
391
- # List of start times of the available profiles for the aggregation
392
- # period in the specified time range.
403
+ # The list of start times of the available profiles for the
404
+ # aggregation period in the specified time range.
393
405
  # @return [Array<Types::ProfileTime>]
394
406
  #
395
407
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ListProfileTimesResponse AWS API Documentation
@@ -400,7 +412,7 @@ module Aws::CodeGuruProfiler
400
412
  include Aws::Structure
401
413
  end
402
414
 
403
- # Request for ListProfilingGroups operation.
415
+ # The structure representing the listProfilingGroupsRequest.
404
416
  #
405
417
  # @note When making an API call, you may pass ListProfilingGroupsRequest
406
418
  # data as a hash:
@@ -412,16 +424,30 @@ module Aws::CodeGuruProfiler
412
424
  # }
413
425
  #
414
426
  # @!attribute [rw] include_description
415
- # If set to true, returns the full description of the profiling groups
416
- # instead of the names. Defaults to false.
427
+ # A Boolean value indicating whether to include a description.
417
428
  # @return [Boolean]
418
429
  #
419
430
  # @!attribute [rw] max_results
420
- # Upper bound on the number of results to list in a single call.
431
+ # The maximum number of profiling groups results returned by
432
+ # `ListProfilingGroups` in paginated output. When this parameter is
433
+ # used, `ListProfilingGroups` only returns `maxResults` results in a
434
+ # single page along with a `nextToken` response element. The remaining
435
+ # results of the initial request can be seen by sending another
436
+ # `ListProfilingGroups` request with the returned `nextToken` value.
421
437
  # @return [Integer]
422
438
  #
423
439
  # @!attribute [rw] next_token
424
- # Token for paginating results.
440
+ # The `nextToken` value returned from a previous paginated
441
+ # `ListProfilingGroups` request where `maxResults` was used and the
442
+ # results exceeded the value of that parameter. Pagination continues
443
+ # from the end of the previous results that returned the `nextToken`
444
+ # value.
445
+ #
446
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only
447
+ # used to retrieve the next items in a list and not for other
448
+ # programmatic purposes.
449
+ #
450
+ # </note>
425
451
  # @return [String]
426
452
  #
427
453
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ListProfilingGroupsRequest AWS API Documentation
@@ -433,18 +459,22 @@ module Aws::CodeGuruProfiler
433
459
  include Aws::Structure
434
460
  end
435
461
 
436
- # Response for ListProfilingGroups operation.
462
+ # The structure representing the listProfilingGroupsResponse.
437
463
  #
438
464
  # @!attribute [rw] next_token
439
- # Token for paginating results.
465
+ # The `nextToken` value to include in a future `ListProfilingGroups`
466
+ # request. When the results of a `ListProfilingGroups` request exceed
467
+ # `maxResults`, this value can be used to retrieve the next page of
468
+ # results. This value is `null` when there are no more results to
469
+ # return.
440
470
  # @return [String]
441
471
  #
442
472
  # @!attribute [rw] profiling_group_names
443
- # List of profiling group names.
473
+ # Information about profiling group names.
444
474
  # @return [Array<String>]
445
475
  #
446
476
  # @!attribute [rw] profiling_groups
447
- # List of profiling group descriptions.
477
+ # Information about profiling groups.
448
478
  # @return [Array<Types::ProfilingGroupDescription>]
449
479
  #
450
480
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ListProfilingGroupsResponse AWS API Documentation
@@ -456,7 +486,7 @@ module Aws::CodeGuruProfiler
456
486
  include Aws::Structure
457
487
  end
458
488
 
459
- # Request for PostAgentProfile operation.
489
+ # The structure representing the postAgentProfileRequest.
460
490
  #
461
491
  # @note When making an API call, you may pass PostAgentProfileRequest
462
492
  # data as a hash:
@@ -469,26 +499,17 @@ module Aws::CodeGuruProfiler
469
499
  # }
470
500
  #
471
501
  # @!attribute [rw] agent_profile
472
- # The profile collected by an agent for a time range.
473
502
  # @return [String]
474
503
  #
475
504
  # @!attribute [rw] content_type
476
- # The content type of the agent profile in the payload. Recommended to
477
- # send the profile gzipped with content-type application/octet-stream.
478
- # Other accepted values are application/x-amzn-ion and
479
- # application/json for unzipped Ion and JSON respectively.
480
505
  # @return [String]
481
506
  #
482
507
  # @!attribute [rw] profile_token
483
- # Client generated token to deduplicate the agent profile during
484
- # aggregation.
485
- #
486
508
  # **A suitable default value is auto-generated.** You should normally
487
509
  # not need to pass this option.
488
510
  # @return [String]
489
511
  #
490
512
  # @!attribute [rw] profiling_group_name
491
- # The name of the profiling group.
492
513
  # @return [String]
493
514
  #
494
515
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/PostAgentProfileRequest AWS API Documentation
@@ -501,14 +522,13 @@ module Aws::CodeGuruProfiler
501
522
  include Aws::Structure
502
523
  end
503
524
 
504
- # Response for PostAgentProfile operation.
525
+ # The structure representing the postAgentProfileResponse.
505
526
  #
506
527
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/PostAgentProfileResponse AWS API Documentation
507
528
  #
508
529
  class PostAgentProfileResponse < Aws::EmptyStructure; end
509
530
 
510
- # Periods of time used for aggregation of profiles, represented using
511
- # ISO 8601 format.
531
+ # Information about the profile time.
512
532
  #
513
533
  # @!attribute [rw] start
514
534
  # The start time of the profile.
@@ -524,17 +544,15 @@ module Aws::CodeGuruProfiler
524
544
  # The description of a profiling group.
525
545
  #
526
546
  # @!attribute [rw] agent_orchestration_config
527
- # Configuration to orchestrate agents to create and report agent
528
- # profiles of the profiling group. Agents are orchestrated if they
529
- # follow the agent orchestration protocol.
530
547
  # @return [Types::AgentOrchestrationConfig]
531
548
  #
532
549
  # @!attribute [rw] arn
533
- # The ARN of the profiling group.
550
+ # The Amazon Resource Name (ARN) identifying the profiling group.
534
551
  # @return [String]
535
552
  #
536
553
  # @!attribute [rw] created_at
537
- # The timestamp of when the profiling group was created.
554
+ # The time, in milliseconds since the epoch, when the profiling group
555
+ # was created.
538
556
  # @return [Time]
539
557
  #
540
558
  # @!attribute [rw] name
@@ -542,11 +560,12 @@ module Aws::CodeGuruProfiler
542
560
  # @return [String]
543
561
  #
544
562
  # @!attribute [rw] profiling_status
545
- # The status of profiling of a profiling group.
563
+ # The status of the profiling group.
546
564
  # @return [Types::ProfilingStatus]
547
565
  #
548
566
  # @!attribute [rw] updated_at
549
- # The timestamp of when the profiling group was last updated.
567
+ # The time, in milliseconds since the epoch, when the profiling group
568
+ # was last updated.
550
569
  # @return [Time]
551
570
  #
552
571
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ProfilingGroupDescription AWS API Documentation
@@ -561,20 +580,20 @@ module Aws::CodeGuruProfiler
561
580
  include Aws::Structure
562
581
  end
563
582
 
564
- # The status of profiling of a profiling group.
583
+ # Information about the profiling status.
565
584
  #
566
585
  # @!attribute [rw] latest_agent_orchestrated_at
567
- # Timestamp of when the last interaction of the agent with
568
- # configureAgent API for orchestration.
586
+ # The time, in milliseconds since the epoch, when the latest agent was
587
+ # orchestrated.
569
588
  # @return [Time]
570
589
  #
571
590
  # @!attribute [rw] latest_agent_profile_reported_at
572
- # Timestamp of when the latest agent profile was successfully
573
- # reported.
591
+ # The time, in milliseconds since the epoch, when the latest agent was
592
+ # reported..
574
593
  # @return [Time]
575
594
  #
576
595
  # @!attribute [rw] latest_aggregated_profile
577
- # The time range of latest aggregated profile available.
596
+ # The latest aggregated profile
578
597
  # @return [Types::AggregatedProfileTime]
579
598
  #
580
599
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ProfilingStatus AWS API Documentation
@@ -586,7 +605,7 @@ module Aws::CodeGuruProfiler
586
605
  include Aws::Structure
587
606
  end
588
607
 
589
- # Request references a resource which does not exist.
608
+ # The resource specified in the request does not exist.
590
609
  #
591
610
  # @!attribute [rw] message
592
611
  # @return [String]
@@ -598,7 +617,13 @@ module Aws::CodeGuruProfiler
598
617
  include Aws::Structure
599
618
  end
600
619
 
601
- # Request would cause a service quota to be exceeded.
620
+ # You have exceeded your service quota. To perform the requested action,
621
+ # remove some of the relevant resources, or use [Service Quotas][1] to
622
+ # request a service quota increase.
623
+ #
624
+ #
625
+ #
626
+ # [1]: https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html
602
627
  #
603
628
  # @!attribute [rw] message
604
629
  # @return [String]
@@ -610,7 +635,7 @@ module Aws::CodeGuruProfiler
610
635
  include Aws::Structure
611
636
  end
612
637
 
613
- # Request was denied due to request throttling.
638
+ # The request was denied due to request throttling.
614
639
  #
615
640
  # @!attribute [rw] message
616
641
  # @return [String]
@@ -622,7 +647,7 @@ module Aws::CodeGuruProfiler
622
647
  include Aws::Structure
623
648
  end
624
649
 
625
- # Request for UpdateProfilingGroup operation.
650
+ # The structure representing the updateProfilingGroupRequest.
626
651
  #
627
652
  # @note When making an API call, you may pass UpdateProfilingGroupRequest
628
653
  # data as a hash:
@@ -635,11 +660,10 @@ module Aws::CodeGuruProfiler
635
660
  # }
636
661
  #
637
662
  # @!attribute [rw] agent_orchestration_config
638
- # Remote configuration to configure the agents of the profiling group.
639
663
  # @return [Types::AgentOrchestrationConfig]
640
664
  #
641
665
  # @!attribute [rw] profiling_group_name
642
- # The name of the profiling group.
666
+ # The name of the profiling group to update.
643
667
  # @return [String]
644
668
  #
645
669
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/UpdateProfilingGroupRequest AWS API Documentation
@@ -650,10 +674,10 @@ module Aws::CodeGuruProfiler
650
674
  include Aws::Structure
651
675
  end
652
676
 
653
- # Response for UpdateProfilingGroup operation.
677
+ # The structure representing the updateProfilingGroupResponse.
654
678
  #
655
679
  # @!attribute [rw] profiling_group
656
- # The description of a profiling group.
680
+ # Updated information about the profiling group.
657
681
  # @return [Types::ProfilingGroupDescription]
658
682
  #
659
683
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/UpdateProfilingGroupResponse AWS API Documentation
@@ -663,7 +687,7 @@ module Aws::CodeGuruProfiler
663
687
  include Aws::Structure
664
688
  end
665
689
 
666
- # The input fails to satisfy the constraints of the API.
690
+ # The parameter is not valid.
667
691
  #
668
692
  # @!attribute [rw] message
669
693
  # @return [String]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-codeguruprofiler
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-12-03 00:00:00.000000000 Z
11
+ date: 2020-03-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core