codeguruprofiler

package
v0.20.0 Latest Latest
Warning

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

 Go to latest Published: Mar 17, 2020 License: Apache-2.0 Imports: 8 Imported by: 7

Documentation

Overview

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

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

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".
	//
	// The requested operation would cause a conflict with the current state of
	// a service resource associated with the request. Resolve the conflict before
	// retrying this request.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// The server encountered an internal error and is unable to complete the request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The resource specified in the request does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// You have exceeded your service quota. To perform the requested action, remove
	// some of the relevant resources, or use Service Quotas (https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html)
	// to request a service quota increase.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

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

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The parameter is not valid.
	ErrCodeValidationException = "ValidationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentConfiguration 

type AgentConfiguration struct {

	// PeriodInSeconds is a required field
	PeriodInSeconds *int64 `locationName:"periodInSeconds" type:"integer" required:"true"`

	// ShouldProfile is a required field
	ShouldProfile *bool `locationName:"shouldProfile" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

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 {

	// ProfilingEnabled is a required field
	ProfilingEnabled *bool `locationName:"profilingEnabled" type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

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 time period.
	Period AggregationPeriod `locationName:"period" type:"string" enum:"true"`

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

Information about the time range of the latest available 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
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. 

// 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.

Creates 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.

Deletes 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.

Describes 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.

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. 

// 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.

Lists profiling groups. 

// 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. 

// 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.

Updates 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 {
	FleetInstanceId *string `locationName:"fleetInstanceId" min:"1" type:"string"`

	// ProfilingGroupName is a required field
	ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The structure representing the configureAgentRequest.

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 {

	// Configuration is a required field
	Configuration *AgentConfiguration `locationName:"configuration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The structure representing the configureAgentResponse.

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 {

	// The agent orchestration configuration.
	AgentOrchestrationConfig *AgentOrchestrationConfig `locationName:"agentOrchestrationConfig" type:"structure"`

	// 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.
	//
	// 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
}

The structure representing the createProfiliingGroupRequest.

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 {

	// Information about the new profiling group
	//
	// ProfilingGroup is a required field
	ProfilingGroup *ProfilingGroupDescription `locationName:"profilingGroup" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The structure representing the createProfilingGroupResponse.

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 profiling group name to delete.
	//
	// ProfilingGroupName is a required field
	ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The structure representing the deleteProfilingGroupRequest.

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
}

The structure representing the deleteProfilingGroupResponse.

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 profiling group name.
	//
	// ProfilingGroupName is a required field
	ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The structure representing the describeProfilingGroupRequest.

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 {

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

The structure representing the describeProfilingGroupResponse.

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. You can choose application/json or the
	// default application/x-amzn-ion.
	Accept *string `location:"header" locationName:"Accept" type:"string"`

	// You must specify exactly two of the following parameters: startTime, period,
	// and endTime.
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"`

	// The maximum depth of the graph.
	MaxDepth *int64 `location:"querystring" locationName:"maxDepth" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"period" min:"1" type:"string"`

	// The name of the profiling group to get.
	//
	// 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.
	//
	// You must specify exactly two of the following parameters: startTime, period,
	// and endTime.
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

The structure representing the getProfileRequest.

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.
	ContentEncoding *string `location:"header" locationName:"Content-Encoding" type:"string"`

	// The content type of the profile in the payload. It is either application/json
	// or the default application/x-amzn-ion.
	//
	// ContentType is a required field
	ContentType *string `location:"header" locationName:"Content-Type" type:"string" required:"true"`

	// Information about the profile.
	//
	// Profile is a required field
	Profile []byte `locationName:"profile" type:"blob" required:"true"`
	// contains filtered or unexported fields
}

The structure representing the getProfileResponse.

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 from which to list the profiles.
	//
	// EndTime is a required field
	EndTime *time.Time `location:"querystring" locationName:"endTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// 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 *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

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

	// The aggregation period.
	//
	// 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 from which to list the profiles.
	//
	// StartTime is a required field
	StartTime *time.Time `location:"querystring" locationName:"startTime" type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

The structure representing the listProfileTimesRequest.

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 {

	// 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 `locationName:"nextToken" min:"1" type:"string"`

	// The 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
}

The structure representing the listProfileTimesResponse.

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 {

	// A Boolean value indicating whether to include a description.
	IncludeDescription *bool `location:"querystring" locationName:"includeDescription" type:"boolean"`

	// 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 *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// 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 `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The structure representing the listProfilingGroupsRequest.

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 {

	// 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 `locationName:"nextToken" min:"1" type:"string"`

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

	// Information about profiling groups.
	ProfilingGroups []ProfilingGroupDescription `locationName:"profilingGroups" type:"list"`
	// contains filtered or unexported fields
}

The structure representing the listProfilingGroupsResponse.

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 {

	// AgentProfile is a required field
	AgentProfile []byte `locationName:"agentProfile" type:"blob" required:"true"`

	// ContentType is a required field
	ContentType *string `location:"header" locationName:"Content-Type" type:"string" required:"true"`

	ProfileToken *string `location:"querystring" locationName:"profileToken" min:"1" type:"string" idempotencyToken:"true"`

	// ProfilingGroupName is a required field
	ProfilingGroupName *string `location:"uri" locationName:"profilingGroupName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The structure representing the postAgentProfileRequest.

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
}

The structure representing the postAgentProfileResponse.

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
}

Information about the profile time.

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 {
	AgentOrchestrationConfig *AgentOrchestrationConfig `locationName:"agentOrchestrationConfig" type:"structure"`

	// The Amazon Resource Name (ARN) identifying the profiling group.
	Arn *string `locationName:"arn" type:"string"`

	// The time, in milliseconds since the epoch, 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 the profiling group.
	ProfilingStatus *ProfilingStatus `locationName:"profilingStatus" type:"structure"`

	// The time, in milliseconds since the epoch, 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 {

	// The time, in milliseconds since the epoch, when the latest agent was orchestrated.
	LatestAgentOrchestratedAt *time.Time `locationName:"latestAgentOrchestratedAt" type:"timestamp" timestampFormat:"iso8601"`

	// The time, in milliseconds since the epoch, when the latest agent was reported..
	LatestAgentProfileReportedAt *time.Time `locationName:"latestAgentProfileReportedAt" type:"timestamp" timestampFormat:"iso8601"`

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

Information about the profiling status.

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 {

	// AgentOrchestrationConfig is a required field
	AgentOrchestrationConfig *AgentOrchestrationConfig `locationName:"agentOrchestrationConfig" type:"structure" required:"true"`

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

The structure representing the updateProfilingGroupRequest.

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 {

	// Updated information about the profiling group.
	//
	// ProfilingGroup is a required field
	ProfilingGroup *ProfilingGroupDescription `locationName:"profilingGroup" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The structure representing the updateProfilingGroupResponse.

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.