codeguruprofiler

package
v0.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 30, 2020 License: Apache-2.0 Imports: 7 Imported by: 7

Documentation

Overview

Package codeguruprofiler provides the client and types for making API requests to Amazon CodeGuru Profiler.

Example service documentation.

See https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18 for more information on this service.

See codeguruprofiler package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/codeguruprofiler/

Using the Client

To use Amazon CodeGuru Profiler with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon CodeGuru Profiler client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/codeguruprofiler/#New

Index

Constants

View Source 
const (
	ServiceName = "Amazon CodeGuru Profiler" // Service's name
	ServiceID   = "CodeGuruProfiler"         // Service's identifier
	EndpointsID = "codeguru-profiler"        // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// Request can can cause an inconsistent state for the resource.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Unexpected error during processing of request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Request references a resource which does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// Request would cause a service quota to be exceeded.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints of the API.
	ErrCodeValidationException = "ValidationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentConfiguration 

type AgentConfiguration struct {

	// Specifies the period to follow the configuration (to profile or not) and
	// call back to get a new configuration.
	//
	// PeriodInSeconds is a required field
	PeriodInSeconds *int64 `locationName:"periodInSeconds" type:"integer" required:"true"`

	// Specifies if the profiling should be enabled by the agent.
	//
	// ShouldProfile is a required field
	ShouldProfile *bool `locationName:"shouldProfile" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

The configuration for the agent to use.

func (AgentConfiguration) MarshalFields 

func (s AgentConfiguration) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AgentConfiguration) String 

func (s AgentConfiguration) String() string

String returns the string representation

type AgentOrchestrationConfig 

type AgentOrchestrationConfig struct {

	// If the agents should be enabled to create and report profiles.
	//
	// ProfilingEnabled is a required field
	ProfilingEnabled *bool `locationName:"profilingEnabled" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Configuration to orchestrate agents to create and report agent profiles of the profiling group. Agents are orchestrated if they follow the agent orchestration protocol.

func (AgentOrchestrationConfig) MarshalFields 

func (s AgentOrchestrationConfig) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AgentOrchestrationConfig) String 

func (s AgentOrchestrationConfig) String() string

String returns the string representation

func (*AgentOrchestrationConfig) Validate 

func (s *AgentOrchestrationConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AggregatedProfileTime 

type AggregatedProfileTime struct {

	// The aggregation period of the aggregated profile.
	Period AggregationPeriod `locationName:"period" type:"string" enum:"true"`

	// The start time of the aggregated profile.
	Start *time.Time `locationName:"start" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

The time range of an aggregated profile.

func (AggregatedProfileTime) MarshalFields 

func (s AggregatedProfileTime) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AggregatedProfileTime) String 

func (s AggregatedProfileTime) String() string

String returns the string representation

type AggregationPeriod 

type AggregationPeriod string

Periods of time used for aggregation of profiles, represented using ISO 8601 format. 

const (
	AggregationPeriodP1d  AggregationPeriod = "P1D"
	AggregationPeriodPt1h AggregationPeriod = "PT1H"
	AggregationPeriodPt5m AggregationPeriod = "PT5M"
)

Enum values for AggregationPeriod

func (AggregationPeriod) MarshalValue 

func (enum AggregationPeriod) MarshalValue() (string, error)

func (AggregationPeriod) MarshalValueBuf 

func (enum AggregationPeriod) MarshalValueBuf(b []byte) ([]byte, error)

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon CodeGuru Profiler. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := codeguruprofiler.New(myConfig)

func (*Client) ConfigureAgentRequest 

func (c *Client) ConfigureAgentRequest(input *ConfigureAgentInput) ConfigureAgentRequest

ConfigureAgentRequest returns a request value for making API operation for Amazon CodeGuru Profiler.

Provides the configuration to use for an agent of the profiling group. 

// Example sending a request using ConfigureAgentRequest.
req := client.ConfigureAgentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ConfigureAgent

func (*Client) CreateProfilingGroupRequest 

func (c *Client) CreateProfilingGroupRequest(input *CreateProfilingGroupInput) CreateProfilingGroupRequest

CreateProfilingGroupRequest returns a request value for making API operation for Amazon CodeGuru Profiler.

Create a profiling group. 

// Example sending a request using CreateProfilingGroupRequest.
req := client.CreateProfilingGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/CreateProfilingGroup

func (*Client) DeleteProfilingGroupRequest 

func (c *Client) DeleteProfilingGroupRequest(input *DeleteProfilingGroupInput) DeleteProfilingGroupRequest

DeleteProfilingGroupRequest returns a request value for making API operation for Amazon CodeGuru Profiler.

Delete a profiling group. 

// Example sending a request using DeleteProfilingGroupRequest.
req := client.DeleteProfilingGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/DeleteProfilingGroup

func (*Client) DescribeProfilingGroupRequest 

func (c *Client) DescribeProfilingGroupRequest(input *DescribeProfilingGroupInput) DescribeProfilingGroupRequest

DescribeProfilingGroupRequest returns a request value for making API operation for Amazon CodeGuru Profiler.

Describe a profiling group. 

// Example sending a request using DescribeProfilingGroupRequest.
req := client.DescribeProfilingGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/DescribeProfilingGroup

func (*Client) GetProfileRequest 

func (c *Client) GetProfileRequest(input *GetProfileInput) GetProfileRequest

GetProfileRequest returns a request value for making API operation for Amazon CodeGuru Profiler.

Get 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 will be 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 instance, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, then the returned profile will be from 00:15 to 00:20. 

// Example sending a request using GetProfileRequest.
req := client.GetProfileRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/GetProfile

func (*Client) ListProfileTimesRequest 

func (c *Client) ListProfileTimesRequest(input *ListProfileTimesInput) ListProfileTimesRequest

ListProfileTimesRequest returns a request value for making API operation for Amazon CodeGuru Profiler.

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

// Example sending a request using ListProfileTimesRequest.
req := client.ListProfileTimesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ListProfileTimes

func (*Client) ListProfilingGroupsRequest 

func (c *Client) ListProfilingGroupsRequest(input *ListProfilingGroupsInput) ListProfilingGroupsRequest

ListProfilingGroupsRequest returns a request value for making API operation for Amazon CodeGuru Profiler.

List profiling groups in the account. 

// Example sending a request using ListProfilingGroupsRequest.
req := client.ListProfilingGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/ListProfilingGroups

func (*Client) PostAgentProfileRequest 

func (c *Client) PostAgentProfileRequest(input *PostAgentProfileInput) PostAgentProfileRequest

PostAgentProfileRequest returns a request value for making API operation for Amazon CodeGuru Profiler.

Submit profile collected by an agent belonging to a profiling group for aggregation. 

// Example sending a request using PostAgentProfileRequest.
req := client.PostAgentProfileRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/PostAgentProfile

func (*Client) UpdateProfilingGroupRequest 

func (c *Client) UpdateProfilingGroupRequest(input *UpdateProfilingGroupInput) UpdateProfilingGroupRequest

UpdateProfilingGroupRequest returns a request value for making API operation for Amazon CodeGuru Profiler.

Update a profiling group. 

// Example sending a request using UpdateProfilingGroupRequest.
req := client.UpdateProfilingGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/codeguruprofiler-2019-07-18/UpdateProfilingGroup

type ConfigureAgentInput 

type ConfigureAgentInput struct {

	// Identifier of the instance of compute fleet being profiled by the agent.
	// For instance, host name in EC2, task id for ECS, function name for AWS Lambda
	FleetInstanceId *string `locationName:"fleetInstanceId" min:"1" type:"string"`

	// The name of the profiling group.
	//
	// ProfilingGroupName is a required field
	ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request for ConfigureAgent operation.

func (ConfigureAgentInput) MarshalFields 

func (s ConfigureAgentInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ConfigureAgentInput) String 

func (s ConfigureAgentInput) String() string

String returns the string representation

func (*ConfigureAgentInput) Validate 

func (s *ConfigureAgentInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConfigureAgentOutput 

type ConfigureAgentOutput struct {

	// The configuration for the agent to use.
	//
	// Configuration is a required field
	Configuration *AgentConfiguration `locationName:"configuration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Response for ConfigureAgent operation.

func (ConfigureAgentOutput) MarshalFields 

func (s ConfigureAgentOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ConfigureAgentOutput) String 

func (s ConfigureAgentOutput) String() string

String returns the string representation

type ConfigureAgentRequest 

type ConfigureAgentRequest struct {
	*aws.Request
	Input *ConfigureAgentInput
	Copy  func(*ConfigureAgentInput) ConfigureAgentRequest
}

ConfigureAgentRequest is the request type for the ConfigureAgent API operation.

func (ConfigureAgentRequest) Send 

func (r ConfigureAgentRequest) Send(ctx context.Context) (*ConfigureAgentResponse, error)

Send marshals and sends the ConfigureAgent API request.

type ConfigureAgentResponse 

type ConfigureAgentResponse struct {
	*ConfigureAgentOutput
	// contains filtered or unexported fields
}

ConfigureAgentResponse is the response type for the ConfigureAgent API operation.

func (*ConfigureAgentResponse) SDKResponseMetdata 

func (r *ConfigureAgentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ConfigureAgent request.

type CreateProfilingGroupInput 

type CreateProfilingGroupInput struct {

	// Configuration to orchestrate agents to create and report agent profiles of
	// the profiling group. Agents are orchestrated if they follow the agent orchestration
	// protocol.
	AgentOrchestrationConfig *AgentOrchestrationConfig `locationName:"agentOrchestrationConfig" type:"structure"`

	// Client token for the request.
	//
	// ClientToken is a required field
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" required:"true" idempotencyToken:"true"`

	// The name of the profiling group.
	//
	// ProfilingGroupName is a required field
	ProfilingGroupName *string `locationName:"profilingGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request for CreateProfilingGroup operation.

func (CreateProfilingGroupInput) MarshalFields 

func (s CreateProfilingGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateProfilingGroupInput) String 

func (s CreateProfilingGroupInput) String() string

String returns the string representation

func (*CreateProfilingGroupInput) Validate 

func (s *CreateProfilingGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateProfilingGroupOutput 

type CreateProfilingGroupOutput struct {

	// The description of a profiling group.
	//
	// ProfilingGroup is a required field
	ProfilingGroup *ProfilingGroupDescription `locationName:"profilingGroup" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Response for CreateProfilingGroup operation.

func (CreateProfilingGroupOutput) MarshalFields 

func (s CreateProfilingGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateProfilingGroupOutput) String 

func (s CreateProfilingGroupOutput) String() string

String returns the string representation

type CreateProfilingGroupRequest 

type CreateProfilingGroupRequest struct {
	*aws.Request
	Input *CreateProfilingGroupInput
	Copy  func(*CreateProfilingGroupInput) CreateProfilingGroupRequest
}

CreateProfilingGroupRequest is the request type for the CreateProfilingGroup API operation.

func (CreateProfilingGroupRequest) Send 

func (r CreateProfilingGroupRequest) Send(ctx context.Context) (*CreateProfilingGroupResponse, error)

Send marshals and sends the CreateProfilingGroup API request.

type CreateProfilingGroupResponse 

type CreateProfilingGroupResponse struct {
	*CreateProfilingGroupOutput
	// contains filtered or unexported fields
}

CreateProfilingGroupResponse is the response type for the CreateProfilingGroup API operation.

func (*CreateProfilingGroupResponse) SDKResponseMetdata 

func (r *CreateProfilingGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateProfilingGroup request.

type DeleteProfilingGroupInput 

type DeleteProfilingGroupInput struct {

	// The name of the profiling group.
	//
	// ProfilingGroupName is a required field
	ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request for DeleteProfilingGroup operation.

func (DeleteProfilingGroupInput) MarshalFields 

func (s DeleteProfilingGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteProfilingGroupInput) String 

func (s DeleteProfilingGroupInput) String() string

String returns the string representation

func (*DeleteProfilingGroupInput) Validate 

func (s *DeleteProfilingGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteProfilingGroupOutput 

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

Response for DeleteProfilingGroup operation.

func (DeleteProfilingGroupOutput) MarshalFields 

func (s DeleteProfilingGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteProfilingGroupOutput) String 

func (s DeleteProfilingGroupOutput) String() string

String returns the string representation

type DeleteProfilingGroupRequest 

type DeleteProfilingGroupRequest struct {
	*aws.Request
	Input *DeleteProfilingGroupInput
	Copy  func(*DeleteProfilingGroupInput) DeleteProfilingGroupRequest
}

DeleteProfilingGroupRequest is the request type for the DeleteProfilingGroup API operation.

func (DeleteProfilingGroupRequest) Send 

func (r DeleteProfilingGroupRequest) Send(ctx context.Context) (*DeleteProfilingGroupResponse, error)

Send marshals and sends the DeleteProfilingGroup API request.

type DeleteProfilingGroupResponse 

type DeleteProfilingGroupResponse struct {
	*DeleteProfilingGroupOutput
	// contains filtered or unexported fields
}

DeleteProfilingGroupResponse is the response type for the DeleteProfilingGroup API operation.

func (*DeleteProfilingGroupResponse) SDKResponseMetdata 

func (r *DeleteProfilingGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteProfilingGroup request.

type DescribeProfilingGroupInput 

type DescribeProfilingGroupInput struct {

	// The name of the profiling group.
	//
	// ProfilingGroupName is a required field
	ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request for DescribeProfilingGroup operation.

func (DescribeProfilingGroupInput) MarshalFields 

func (s DescribeProfilingGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeProfilingGroupInput) String 

func (s DescribeProfilingGroupInput) String() string

String returns the string representation

func (*DescribeProfilingGroupInput) Validate 

func (s *DescribeProfilingGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeProfilingGroupOutput 

type DescribeProfilingGroupOutput struct {

	// The description of a profiling group.
	//
	// ProfilingGroup is a required field
	ProfilingGroup *ProfilingGroupDescription `locationName:"profilingGroup" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Response for DescribeProfilingGroup operation.

func (DescribeProfilingGroupOutput) MarshalFields 

func (s DescribeProfilingGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeProfilingGroupOutput) String 

func (s DescribeProfilingGroupOutput) String() string

String returns the string representation

type DescribeProfilingGroupRequest 

type DescribeProfilingGroupRequest struct {
	*aws.Request
	Input *DescribeProfilingGroupInput
	Copy  func(*DescribeProfilingGroupInput) DescribeProfilingGroupRequest
}

DescribeProfilingGroupRequest is the request type for the DescribeProfilingGroup API operation.

func (DescribeProfilingGroupRequest) Send 

func (r DescribeProfilingGroupRequest) Send(ctx context.Context) (*DescribeProfilingGroupResponse, error)

Send marshals and sends the DescribeProfilingGroup API request.

type DescribeProfilingGroupResponse 

type DescribeProfilingGroupResponse struct {
	*DescribeProfilingGroupOutput
	// contains filtered or unexported fields
}

DescribeProfilingGroupResponse is the response type for the DescribeProfilingGroup API operation.

func (*DescribeProfilingGroupResponse) SDKResponseMetdata 

func (r *DescribeProfilingGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeProfilingGroup request.

type GetProfileInput 

type GetProfileInput struct {

	// The format of the profile to return. Supports application/json or application/x-amzn-ion.
	// Defaults to application/x-amzn-ion.
	Accept *string `location:"header" locationName:"Accept" type:"string"`

	// The end time of the profile to get. Either period or endTime must be specified.
	// Must be greater than start and the overall time range to be in the past and
	// not larger than a week.
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"`

	// Limit the max depth of the profile.
	MaxDepth *int64 `location:"querystring" locationName:"maxDepth" min:"1" type:"integer"`

	// The period of the profile to get. Exactly two of startTime, period and endTime
	// must be specified. Must be positive and the overall time range to be in the
	// past and not larger than a week.
	Period *string `location:"querystring" locationName:"period" min:"1" type:"string"`

	// The name of the profiling group.
	//
	// ProfilingGroupName is a required field
	ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"`

	// The start time of the profile to get.
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

Request for GetProfile operation.

func (GetProfileInput) MarshalFields 

func (s GetProfileInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetProfileInput) String 

func (s GetProfileInput) String() string

String returns the string representation

func (*GetProfileInput) Validate 

func (s *GetProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetProfileOutput 

type GetProfileOutput struct {

	// The content encoding of the profile in the payload.
	ContentEncoding *string `location:"header" locationName:"Content-Encoding" type:"string"`

	// The content type of the profile in the payload. Will be application/json
	// or application/x-amzn-ion based on Accept header in the request.
	//
	// ContentType is a required field
	ContentType *string `location:"header" locationName:"Content-Type" type:"string" required:"true"`

	// The profile representing the aggregation of agent profiles of the profiling
	// group for a time range.
	//
	// Profile is a required field
	Profile []byte `locationName:"profile" type:"blob" required:"true"`
	// contains filtered or unexported fields
}

Response for GetProfile operation.

func (GetProfileOutput) MarshalFields 

func (s GetProfileOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetProfileOutput) String 

func (s GetProfileOutput) String() string

String returns the string representation

type GetProfileRequest 

type GetProfileRequest struct {
	*aws.Request
	Input *GetProfileInput
	Copy  func(*GetProfileInput) GetProfileRequest
}

GetProfileRequest is the request type for the GetProfile API operation.

func (GetProfileRequest) Send 

func (r GetProfileRequest) Send(ctx context.Context) (*GetProfileResponse, error)

Send marshals and sends the GetProfile API request.

type GetProfileResponse 

type GetProfileResponse struct {
	*GetProfileOutput
	// contains filtered or unexported fields
}

GetProfileResponse is the response type for the GetProfile API operation.

func (*GetProfileResponse) SDKResponseMetdata 

func (r *GetProfileResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetProfile request.

type ListProfileTimesInput 

type ListProfileTimesInput struct {

	// The end time of the time range to list profiles until.
	//
	// EndTime is a required field
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// Upper bound on the number of results to list in a single call.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// Token for paginating results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The order (ascending or descending by start time of the profile) to list
	// the profiles by. Defaults to TIMESTAMP_DESCENDING.
	OrderBy OrderBy `location:"querystring" locationName:"orderBy" type:"string" enum:"true"`

	// The aggregation period to list the profiles for.
	//
	// Period is a required field
	Period AggregationPeriod `location:"querystring" locationName:"period" type:"string" required:"true" enum:"true"`

	// The name of the profiling group.
	//
	// ProfilingGroupName is a required field
	ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"`

	// The start time of the time range to list the profiles from.
	//
	// StartTime is a required field
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

Request for ListProfileTimes operation.

func (ListProfileTimesInput) MarshalFields 

func (s ListProfileTimesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProfileTimesInput) String 

func (s ListProfileTimesInput) String() string

String returns the string representation

func (*ListProfileTimesInput) Validate 

func (s *ListProfileTimesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListProfileTimesOutput 

type ListProfileTimesOutput struct {

	// Token for paginating results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// List of start times of the available profiles for the aggregation period
	// in the specified time range.
	//
	// ProfileTimes is a required field
	ProfileTimes []ProfileTime `locationName:"profileTimes" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Response for ListProfileTimes operation.

func (ListProfileTimesOutput) MarshalFields 

func (s ListProfileTimesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProfileTimesOutput) String 

func (s ListProfileTimesOutput) String() string

String returns the string representation

type ListProfileTimesPaginator 

type ListProfileTimesPaginator struct {
	aws.Pager
}

ListProfileTimesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListProfileTimesPaginator 

func NewListProfileTimesPaginator(req ListProfileTimesRequest) ListProfileTimesPaginator

NewListProfileTimesRequestPaginator returns a paginator for ListProfileTimes. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListProfileTimesRequest(input)
p := codeguruprofiler.NewListProfileTimesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListProfileTimesPaginator) CurrentPage 

func (p *ListProfileTimesPaginator) CurrentPage() *ListProfileTimesOutput

type ListProfileTimesRequest 

type ListProfileTimesRequest struct {
	*aws.Request
	Input *ListProfileTimesInput
	Copy  func(*ListProfileTimesInput) ListProfileTimesRequest
}

ListProfileTimesRequest is the request type for the ListProfileTimes API operation.

func (ListProfileTimesRequest) Send 

func (r ListProfileTimesRequest) Send(ctx context.Context) (*ListProfileTimesResponse, error)

Send marshals and sends the ListProfileTimes API request.

type ListProfileTimesResponse 

type ListProfileTimesResponse struct {
	*ListProfileTimesOutput
	// contains filtered or unexported fields
}

ListProfileTimesResponse is the response type for the ListProfileTimes API operation.

func (*ListProfileTimesResponse) SDKResponseMetdata 

func (r *ListProfileTimesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListProfileTimes request.

type ListProfilingGroupsInput 

type ListProfilingGroupsInput struct {

	// If set to true, returns the full description of the profiling groups instead
	// of the names. Defaults to false.
	IncludeDescription *bool `location:"querystring" locationName:"includeDescription" type:"boolean"`

	// Upper bound on the number of results to list in a single call.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// Token for paginating results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Request for ListProfilingGroups operation.

func (ListProfilingGroupsInput) MarshalFields 

func (s ListProfilingGroupsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProfilingGroupsInput) String 

func (s ListProfilingGroupsInput) String() string

String returns the string representation

func (*ListProfilingGroupsInput) Validate 

func (s *ListProfilingGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListProfilingGroupsOutput 

type ListProfilingGroupsOutput struct {

	// Token for paginating results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// List of profiling group names.
	//
	// ProfilingGroupNames is a required field
	ProfilingGroupNames []string `locationName:"profilingGroupNames" type:"list" required:"true"`

	// List of profiling group descriptions.
	ProfilingGroups []ProfilingGroupDescription `locationName:"profilingGroups" type:"list"`
	// contains filtered or unexported fields
}

Response for ListProfilingGroups operation.

func (ListProfilingGroupsOutput) MarshalFields 

func (s ListProfilingGroupsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProfilingGroupsOutput) String 

func (s ListProfilingGroupsOutput) String() string

String returns the string representation

type ListProfilingGroupsPaginator 

type ListProfilingGroupsPaginator struct {
	aws.Pager
}

ListProfilingGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListProfilingGroupsPaginator 

func NewListProfilingGroupsPaginator(req ListProfilingGroupsRequest) ListProfilingGroupsPaginator

NewListProfilingGroupsRequestPaginator returns a paginator for ListProfilingGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListProfilingGroupsRequest(input)
p := codeguruprofiler.NewListProfilingGroupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListProfilingGroupsPaginator) CurrentPage 

func (p *ListProfilingGroupsPaginator) CurrentPage() *ListProfilingGroupsOutput

type ListProfilingGroupsRequest 

type ListProfilingGroupsRequest struct {
	*aws.Request
	Input *ListProfilingGroupsInput
	Copy  func(*ListProfilingGroupsInput) ListProfilingGroupsRequest
}

ListProfilingGroupsRequest is the request type for the ListProfilingGroups API operation.

func (ListProfilingGroupsRequest) Send 

func (r ListProfilingGroupsRequest) Send(ctx context.Context) (*ListProfilingGroupsResponse, error)

Send marshals and sends the ListProfilingGroups API request.

type ListProfilingGroupsResponse 

type ListProfilingGroupsResponse struct {
	*ListProfilingGroupsOutput
	// contains filtered or unexported fields
}

ListProfilingGroupsResponse is the response type for the ListProfilingGroups API operation.

func (*ListProfilingGroupsResponse) SDKResponseMetdata 

func (r *ListProfilingGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListProfilingGroups request.

type OrderBy 

type OrderBy string
const (
	OrderByTimestampAscending  OrderBy = "TimestampAscending"
	OrderByTimestampDescending OrderBy = "TimestampDescending"
)

Enum values for OrderBy

func (OrderBy) MarshalValue 

func (enum OrderBy) MarshalValue() (string, error)

func (OrderBy) MarshalValueBuf 

func (enum OrderBy) MarshalValueBuf(b []byte) ([]byte, error)

type PostAgentProfileInput 

type PostAgentProfileInput struct {

	// The profile collected by an agent for a time range.
	//
	// AgentProfile is a required field
	AgentProfile []byte `locationName:"agentProfile" type:"blob" required:"true"`

	// The content type of the agent profile in the payload. Recommended to send
	// the profile gzipped with content-type application/octet-stream. Other accepted
	// values are application/x-amzn-ion and application/json for unzipped Ion and
	// JSON respectively.
	//
	// ContentType is a required field
	ContentType *string `location:"header" locationName:"Content-Type" type:"string" required:"true"`

	// Client generated token to deduplicate the agent profile during aggregation.
	ProfileToken *string `location:"querystring" locationName:"profileToken" min:"1" type:"string" idempotencyToken:"true"`

	// The name of the profiling group.
	//
	// ProfilingGroupName is a required field
	ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request for PostAgentProfile operation.

func (PostAgentProfileInput) MarshalFields 

func (s PostAgentProfileInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PostAgentProfileInput) String 

func (s PostAgentProfileInput) String() string

String returns the string representation

func (*PostAgentProfileInput) Validate 

func (s *PostAgentProfileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PostAgentProfileOutput 

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

Response for PostAgentProfile operation.

func (PostAgentProfileOutput) MarshalFields 

func (s PostAgentProfileOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PostAgentProfileOutput) String 

func (s PostAgentProfileOutput) String() string

String returns the string representation

type PostAgentProfileRequest 

type PostAgentProfileRequest struct {
	*aws.Request
	Input *PostAgentProfileInput
	Copy  func(*PostAgentProfileInput) PostAgentProfileRequest
}

PostAgentProfileRequest is the request type for the PostAgentProfile API operation.

func (PostAgentProfileRequest) Send 

func (r PostAgentProfileRequest) Send(ctx context.Context) (*PostAgentProfileResponse, error)

Send marshals and sends the PostAgentProfile API request.

type PostAgentProfileResponse 

type PostAgentProfileResponse struct {
	*PostAgentProfileOutput
	// contains filtered or unexported fields
}

PostAgentProfileResponse is the response type for the PostAgentProfile API operation.

func (*PostAgentProfileResponse) SDKResponseMetdata 

func (r *PostAgentProfileResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the PostAgentProfile request.

type ProfileTime 

type ProfileTime struct {

	// The start time of the profile.
	Start *time.Time `locationName:"start" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

Periods of time used for aggregation of profiles, represented using ISO 8601 format.

func (ProfileTime) MarshalFields 

func (s ProfileTime) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ProfileTime) String 

func (s ProfileTime) String() string

String returns the string representation

type ProfilingGroupDescription 

type ProfilingGroupDescription struct {

	// Configuration to orchestrate agents to create and report agent profiles of
	// the profiling group. Agents are orchestrated if they follow the agent orchestration
	// protocol.
	AgentOrchestrationConfig *AgentOrchestrationConfig `locationName:"agentOrchestrationConfig" type:"structure"`

	// The ARN of the profiling group.
	Arn *string `locationName:"arn" type:"string"`

	// The timestamp of when the profiling group was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"iso8601"`

	// The name of the profiling group.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The status of profiling of a profiling group.
	ProfilingStatus *ProfilingStatus `locationName:"profilingStatus" type:"structure"`

	// The timestamp of when the profiling group was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

The description of a profiling group.

func (ProfilingGroupDescription) MarshalFields 

func (s ProfilingGroupDescription) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ProfilingGroupDescription) String 

func (s ProfilingGroupDescription) String() string

String returns the string representation

type ProfilingStatus 

type ProfilingStatus struct {

	// Timestamp of when the last interaction of the agent with configureAgent API
	// for orchestration.
	LatestAgentOrchestratedAt *time.Time `locationName:"latestAgentOrchestratedAt" type:"timestamp" timestampFormat:"iso8601"`

	// Timestamp of when the latest agent profile was successfully reported.
	LatestAgentProfileReportedAt *time.Time `locationName:"latestAgentProfileReportedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The time range of latest aggregated profile available.
	LatestAggregatedProfile *AggregatedProfileTime `locationName:"latestAggregatedProfile" type:"structure"`
	// contains filtered or unexported fields
}

The status of profiling of a profiling group.

func (ProfilingStatus) MarshalFields 

func (s ProfilingStatus) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ProfilingStatus) String 

func (s ProfilingStatus) String() string

String returns the string representation

type UpdateProfilingGroupInput 

type UpdateProfilingGroupInput struct {

	// Remote configuration to configure the agents of the profiling group.
	//
	// AgentOrchestrationConfig is a required field
	AgentOrchestrationConfig *AgentOrchestrationConfig `locationName:"agentOrchestrationConfig" type:"structure" required:"true"`

	// The name of the profiling group.
	//
	// ProfilingGroupName is a required field
	ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request for UpdateProfilingGroup operation.

func (UpdateProfilingGroupInput) MarshalFields 

func (s UpdateProfilingGroupInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateProfilingGroupInput) String 

func (s UpdateProfilingGroupInput) String() string

String returns the string representation

func (*UpdateProfilingGroupInput) Validate 

func (s *UpdateProfilingGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateProfilingGroupOutput 

type UpdateProfilingGroupOutput struct {

	// The description of a profiling group.
	//
	// ProfilingGroup is a required field
	ProfilingGroup *ProfilingGroupDescription `locationName:"profilingGroup" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Response for UpdateProfilingGroup operation.

func (UpdateProfilingGroupOutput) MarshalFields 

func (s UpdateProfilingGroupOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateProfilingGroupOutput) String 

func (s UpdateProfilingGroupOutput) String() string

String returns the string representation

type UpdateProfilingGroupRequest 

type UpdateProfilingGroupRequest struct {
	*aws.Request
	Input *UpdateProfilingGroupInput
	Copy  func(*UpdateProfilingGroupInput) UpdateProfilingGroupRequest
}

UpdateProfilingGroupRequest is the request type for the UpdateProfilingGroup API operation.

func (UpdateProfilingGroupRequest) Send 

func (r UpdateProfilingGroupRequest) Send(ctx context.Context) (*UpdateProfilingGroupResponse, error)

Send marshals and sends the UpdateProfilingGroup API request.

type UpdateProfilingGroupResponse 

type UpdateProfilingGroupResponse struct {
	*UpdateProfilingGroupOutput
	// contains filtered or unexported fields
}

UpdateProfilingGroupResponse is the response type for the UpdateProfilingGroup API operation.

func (*UpdateProfilingGroupResponse) SDKResponseMetdata 

func (r *UpdateProfilingGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateProfilingGroup request.

Source Files

View all Source files

Directories

Path Synopsis
Package codeguruprofileriface provides an interface to enable mocking the Amazon CodeGuru Profiler service client for testing your code.
 Package codeguruprofileriface provides an interface to enable mocking the Amazon CodeGuru Profiler service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.