codeguruprofiler – github.com/aws/aws-sdk-go-v2/service/codeguruprofiler Index | Files | Directories

package codeguruprofiler

import "github.com/aws/aws-sdk-go-v2/service/codeguruprofiler"

Package codeguruprofiler provides the API client, operations, and parameter types for Amazon CodeGuru Profiler.

This section provides documentation for the Amazon CodeGuru Profiler API operations.

Index

Constants

const ServiceAPIVersion = "2019-07-18"
const ServiceID = "CodeGuruProfiler"

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for Amazon CodeGuru Profiler.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) ConfigureAgent

func (c *Client) ConfigureAgent(ctx context.Context, params *ConfigureAgentInput, optFns ...func(*Options)) (*ConfigureAgentOutput, error)

func (*Client) CreateProfilingGroup

func (c *Client) CreateProfilingGroup(ctx context.Context, params *CreateProfilingGroupInput, optFns ...func(*Options)) (*CreateProfilingGroupOutput, error)

Creates a profiling group.

func (*Client) DeleteProfilingGroup

func (c *Client) DeleteProfilingGroup(ctx context.Context, params *DeleteProfilingGroupInput, optFns ...func(*Options)) (*DeleteProfilingGroupOutput, error)

Deletes a profiling group.

func (*Client) DescribeProfilingGroup

func (c *Client) DescribeProfilingGroup(ctx context.Context, params *DescribeProfilingGroupInput, optFns ...func(*Options)) (*DescribeProfilingGroupOutput, error)

Describes a profiling group.

func (*Client) GetPolicy

func (c *Client) GetPolicy(ctx context.Context, params *GetPolicyInput, optFns ...func(*Options)) (*GetPolicyOutput, error)

Gets the profiling group policy.

func (*Client) GetProfile

func (c *Client) GetProfile(ctx context.Context, params *GetProfileInput, optFns ...func(*Options)) (*GetProfileOutput, error)

Gets the aggregated profile of a profiling group for the specified time range. If the requested time range does not align with the available aggregated profiles, it is expanded to attain alignment. If aggregated profiles are available only for part of the period requested, the profile is returned from the earliest available to the latest within the requested time range. For example, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, the returned profile will be from 00:15 to 00:20. You must specify exactly two of the following parameters: startTime, period, and endTime.

func (*Client) ListProfileTimes

func (c *Client) ListProfileTimes(ctx context.Context, params *ListProfileTimesInput, optFns ...func(*Options)) (*ListProfileTimesOutput, error)

List the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.

func (*Client) ListProfilingGroups

func (c *Client) ListProfilingGroups(ctx context.Context, params *ListProfilingGroupsInput, optFns ...func(*Options)) (*ListProfilingGroupsOutput, error)

Lists profiling groups.

func (*Client) PostAgentProfile

func (c *Client) PostAgentProfile(ctx context.Context, params *PostAgentProfileInput, optFns ...func(*Options)) (*PostAgentProfileOutput, error)

func (*Client) PutPermission

func (c *Client) PutPermission(ctx context.Context, params *PutPermissionInput, optFns ...func(*Options)) (*PutPermissionOutput, error)

Provides permission to the principals. This overwrites the existing permissions, and is not additive.

func (*Client) RemovePermission

func (c *Client) RemovePermission(ctx context.Context, params *RemovePermissionInput, optFns ...func(*Options)) (*RemovePermissionOutput, error)

Removes statement for the provided action group from the policy.

func (*Client) RetrieveTimeSeries

func (c *Client) RetrieveTimeSeries(ctx context.Context, params *RetrieveTimeSeriesInput, optFns ...func(*Options)) (*RetrieveTimeSeriesOutput, error)

func (*Client) UpdateProfilingGroup

func (c *Client) UpdateProfilingGroup(ctx context.Context, params *UpdateProfilingGroupInput, optFns ...func(*Options)) (*UpdateProfilingGroupOutput, error)

Updates a profiling group.

type ConfigureAgentInput

type ConfigureAgentInput struct {

	//
	//
	// This member is required.
	ProfilingGroupName *string

	//
	FleetInstanceId *string

	Metadata map[string]*string
}

The structure representing the configureAgentRequest.

type ConfigureAgentOutput

type ConfigureAgentOutput struct {

	//
	//
	// This member is required.
	Configuration *types.AgentConfiguration

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the configureAgentResponse.

type CreateProfilingGroupInput

type CreateProfilingGroupInput struct {

	// Unique, case-sensitive identifier that you provide to ensure the idempotency of
	// the request. This parameter specifies a unique identifier for the new profiling
	// group that helps ensure idempotency.
	//
	// This member is required.
	ClientToken *string

	// The name of the profiling group.
	//
	// This member is required.
	ProfilingGroupName *string

	// The agent orchestration configuration.
	AgentOrchestrationConfig *types.AgentOrchestrationConfig

	ComputePlatform types.ComputePlatform
}

The structure representing the createProfiliingGroupRequest.

type CreateProfilingGroupOutput

type CreateProfilingGroupOutput struct {

	// Information about the new profiling group
	//
	// This member is required.
	ProfilingGroup *types.ProfilingGroupDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the createProfilingGroupResponse.

type DeleteProfilingGroupInput

type DeleteProfilingGroupInput struct {

	// The profiling group name to delete.
	//
	// This member is required.
	ProfilingGroupName *string
}

The structure representing the deleteProfilingGroupRequest.

type DeleteProfilingGroupOutput

type DeleteProfilingGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the deleteProfilingGroupResponse.

type DescribeProfilingGroupInput

type DescribeProfilingGroupInput struct {

	// The profiling group name.
	//
	// This member is required.
	ProfilingGroupName *string
}

The structure representing the describeProfilingGroupRequest.

type DescribeProfilingGroupOutput

type DescribeProfilingGroupOutput struct {

	// Information about a profiling group.
	//
	// This member is required.
	ProfilingGroup *types.ProfilingGroupDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the describeProfilingGroupResponse.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func WithEndpointResolver

func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver

WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type GetPolicyInput

type GetPolicyInput struct {

	// The name of the profiling group.
	//
	// This member is required.
	ProfilingGroupName *string
}

The structure representing the getPolicyRequest.

type GetPolicyOutput

type GetPolicyOutput struct {

	// The resource-based policy attached to the ProfilingGroup.
	//
	// This member is required.
	Policy *string

	// A unique identifier for the current revision of the policy.
	//
	// This member is required.
	RevisionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the getPolicyResponse.

type GetProfileInput

type GetProfileInput struct {

	// The name of the profiling group to get.
	//
	// This member is required.
	ProfilingGroupName *string

	// The format of the profile to return. You can choose application/json or the
	// default application/x-amzn-ion.
	Accept *string

	// You must specify exactly two of the following parameters: startTime, period, and
	// endTime.
	EndTime *time.Time

	// The maximum depth of the graph.
	MaxDepth *int32

	// The period of the profile to get. The time range must be in the past and not
	// longer than one week. You must specify exactly two of the following parameters:
	// startTime, period, and endTime.
	Period *string

	// The start time of the profile to get. You must specify exactly two of the
	// following parameters: startTime, period, and endTime.
	StartTime *time.Time
}

The structure representing the getProfileRequest.

type GetProfileOutput

type GetProfileOutput struct {

	// The content type of the profile in the payload. It is either application/json or
	// the default application/x-amzn-ion.
	//
	// This member is required.
	ContentType *string

	// Information about the profile.
	//
	// This member is required.
	Profile []byte

	// The content encoding of the profile.
	ContentEncoding *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the getProfileResponse.

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error
}

type ListProfileTimesInput

type ListProfileTimesInput struct {

	// The end time of the time range from which to list the profiles.
	//
	// This member is required.
	EndTime *time.Time

	// The aggregation period.
	//
	// This member is required.
	Period types.AggregationPeriod

	// The name of the profiling group.
	//
	// This member is required.
	ProfilingGroupName *string

	// The start time of the time range from which to list the profiles.
	//
	// This member is required.
	StartTime *time.Time

	// The maximum number of profile time results returned by ListProfileTimes in
	// paginated output. When this parameter is used, ListProfileTimes only returns
	// maxResults results in a single page with a nextToken response element. The
	// remaining results of the initial request can be seen by sending another
	// ListProfileTimes request with the returned nextToken value.
	MaxResults *int32

	// The nextToken value returned from a previous paginated ListProfileTimes request
	// where maxResults was used and the results exceeded the value of that parameter.
	// Pagination continues from the end of the previous results that returned the
	// nextToken value. This token should be treated as an opaque identifier that is
	// only used to retrieve the next items in a list and not for other programmatic
	// purposes.
	NextToken *string

	// The order (ascending or descending by start time of the profile) to use when
	// listing profiles. Defaults to TIMESTAMP_DESCENDING.
	OrderBy types.OrderBy
}

The structure representing the listProfileTimesRequest.

type ListProfileTimesOutput

type ListProfileTimesOutput struct {

	// The list of start times of the available profiles for the aggregation period in
	// the specified time range.
	//
	// This member is required.
	ProfileTimes []*types.ProfileTime

	// The nextToken value to include in a future ListProfileTimes request. When the
	// results of a ListProfileTimes request exceed maxResults, this value can be used
	// to retrieve the next page of results. This value is null when there are no more
	// results to return.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the listProfileTimesResponse.

type ListProfilingGroupsInput

type ListProfilingGroupsInput struct {

	// A Boolean value indicating whether to include a description.
	IncludeDescription *bool

	// The maximum number of profiling groups results returned by ListProfilingGroups
	// in paginated output. When this parameter is used, ListProfilingGroups only
	// returns maxResults results in a single page along with a nextToken response
	// element. The remaining results of the initial request can be seen by sending
	// another ListProfilingGroups request with the returned nextToken value.
	MaxResults *int32

	// The nextToken value returned from a previous paginated ListProfilingGroups
	// request where maxResults was used and the results exceeded the value of that
	// parameter. Pagination continues from the end of the previous results that
	// returned the nextToken value. This token should be treated as an opaque
	// identifier that is only used to retrieve the next items in a list and not for
	// other programmatic purposes.
	NextToken *string
}

The structure representing the listProfilingGroupsRequest.

type ListProfilingGroupsOutput

type ListProfilingGroupsOutput struct {

	// Information about profiling group names.
	//
	// This member is required.
	ProfilingGroupNames []*string

	// The nextToken value to include in a future ListProfilingGroups request. When the
	// results of a ListProfilingGroups request exceed maxResults, this value can be
	// used to retrieve the next page of results. This value is null when there are no
	// more results to return.
	NextToken *string

	// Information about profiling groups.
	ProfilingGroups []*types.ProfilingGroupDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the listProfilingGroupsResponse.

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The region to send requests to. (Required)
	Region string

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer retry.Retryer

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

type PostAgentProfileInput

type PostAgentProfileInput struct {

	//
	//
	// This member is required.
	AgentProfile []byte

	//
	//
	// This member is required.
	ContentType *string

	//
	//
	// This member is required.
	ProfilingGroupName *string

	//
	ProfileToken *string
}

The structure representing the postAgentProfileRequest.

type PostAgentProfileOutput

type PostAgentProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the postAgentProfileResponse.

type PutPermissionInput

type PutPermissionInput struct {

	// The list of actions that the users and roles can perform on the profiling group.
	//
	// This member is required.
	ActionGroup types.ActionGroup

	// The list of role and user ARNs or the accountId that needs access (wildcards are
	// not allowed).
	//
	// This member is required.
	Principals []*string

	// The name of the profiling group.
	//
	// This member is required.
	ProfilingGroupName *string

	// A unique identifier for the current revision of the policy. This is required, if
	// a policy exists for the profiling group. This is not required when creating the
	// policy for the first time.
	RevisionId *string
}

The structure representing the putPermissionRequest.

type PutPermissionOutput

type PutPermissionOutput struct {

	// The resource-based policy.
	//
	// This member is required.
	Policy *string

	// A unique identifier for the current revision of the policy.
	//
	// This member is required.
	RevisionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the putPermissionResponse.

type RemovePermissionInput

type RemovePermissionInput struct {

	// The list of actions that the users and roles can perform on the profiling group.
	//
	// This member is required.
	ActionGroup types.ActionGroup

	// The name of the profiling group.
	//
	// This member is required.
	ProfilingGroupName *string

	// A unique identifier for the current revision of the policy.
	//
	// This member is required.
	RevisionId *string
}

The structure representing the removePermissionRequest.

type RemovePermissionOutput

type RemovePermissionOutput struct {

	// The resource-based policy.
	//
	// This member is required.
	Policy *string

	// A unique identifier for the current revision of the policy.
	//
	// This member is required.
	RevisionId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the removePermissionResponse.

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type RetrieveTimeSeriesInput

type RetrieveTimeSeriesInput struct {
	ProfilingGroupName *string

	EndTime *time.Time

	FrameMetrics []*types.FrameMetric

	Period *string

	StartTime *time.Time

	TargetResolution types.AggregationPeriod
}

type RetrieveTimeSeriesOutput

type RetrieveTimeSeriesOutput struct {
	Data [][]*float64

	EndTime *time.Time

	EndTimes []*time.Time

	FrameMetrics []*types.FrameMetric

	Resolution types.AggregationPeriod

	StartTime *time.Time

	UnprocessedEndTimes map[string][]*time.Time

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateProfilingGroupInput

type UpdateProfilingGroupInput struct {

	//
	//
	// This member is required.
	AgentOrchestrationConfig *types.AgentOrchestrationConfig

	// The name of the profiling group to update.
	//
	// This member is required.
	ProfilingGroupName *string
}

The structure representing the updateProfilingGroupRequest.

type UpdateProfilingGroupOutput

type UpdateProfilingGroupOutput struct {

	// Updated information about the profiling group.
	//
	// This member is required.
	ProfilingGroup *types.ProfilingGroupDescription

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

The structure representing the updateProfilingGroupResponse.

Source Files

api_client.go api_op_ConfigureAgent.go api_op_CreateProfilingGroup.go api_op_DeleteProfilingGroup.go api_op_DescribeProfilingGroup.go api_op_GetPolicy.go api_op_GetProfile.go api_op_ListProfileTimes.go api_op_ListProfilingGroups.go api_op_PostAgentProfile.go api_op_PutPermission.go api_op_RemovePermission.go api_op_RetrieveTimeSeries.go api_op_UpdateProfilingGroup.go deserializers.go doc.go endpoints.go serializers.go validators.go

Directories

PathSynopsis
internal
types
Version
v0.29.0
Published
Oct 31, 2020
Platform
darwin/amd64
Imports
27 packages
Last checked
now

Tools for package owners.