prometheusservice

package
v1.38.18 Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2021 License: Apache-2.0 Imports: 10 Imported by: 32

Documentation

Overview

Package prometheusservice provides the client and types for making API requests to Amazon Prometheus Service.

Amazon Managed Service for Prometheus

See https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01 for more information on this service.

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

Using the Client

To contact Amazon Prometheus Service 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 Prometheus Service client PrometheusService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/prometheusservice/#New

Index

Constants

View Source 
const (
	// ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnknownOperation = "UNKNOWN_OPERATION"

	// ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value
	ValidationExceptionReasonCannotParse = "CANNOT_PARSE"

	// ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
	ValidationExceptionReasonFieldValidationFailed = "FIELD_VALIDATION_FAILED"

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "OTHER"
)

Possible reasons a request failed validation.

View Source 
const (
	// WorkspaceStatusCodeCreating is a WorkspaceStatusCode enum value
	WorkspaceStatusCodeCreating = "CREATING"

	// WorkspaceStatusCodeActive is a WorkspaceStatusCode enum value
	WorkspaceStatusCodeActive = "ACTIVE"

	// WorkspaceStatusCodeUpdating is a WorkspaceStatusCode enum value
	WorkspaceStatusCodeUpdating = "UPDATING"

	// WorkspaceStatusCodeDeleting is a WorkspaceStatusCode enum value
	WorkspaceStatusCodeDeleting = "DELETING"

	// WorkspaceStatusCodeCreationFailed is a WorkspaceStatusCode enum value
	WorkspaceStatusCodeCreationFailed = "CREATION_FAILED"
)

State of a workspace.

View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// User does not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// Updating or deleting a resource can cause an inconsistent state.
	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 specified by an AWS service.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "amp" // Name of service.
	EndpointsID = "aps" // ID to lookup a service endpoint with.
	ServiceID   = "amp" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ValidationExceptionReason_Values 

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

func WorkspaceStatusCode_Values 

func WorkspaceStatusCode_Values() []string

WorkspaceStatusCode_Values returns all elements of the WorkspaceStatusCode enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

User does not have sufficient access to perform this action.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// Identifier of the resource affected.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// Type of the resource affected.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Updating or deleting a resource can cause an inconsistent state.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation

type CreateWorkspaceInput 

type CreateWorkspaceInput struct {

	// An optional user-assigned alias for this workspace. This alias is for user
	// reference and does not need to be unique.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

Represents the input of a CreateWorkspace operation.

func (CreateWorkspaceInput) GoString 

func (s CreateWorkspaceInput) GoString() string

GoString returns the string representation

func (*CreateWorkspaceInput) SetAlias 

func (s *CreateWorkspaceInput) SetAlias(v string) *CreateWorkspaceInput

SetAlias sets the Alias field's value.

func (*CreateWorkspaceInput) SetClientToken 

func (s *CreateWorkspaceInput) SetClientToken(v string) *CreateWorkspaceInput

SetClientToken sets the ClientToken field's value.

func (CreateWorkspaceInput) String 

func (s CreateWorkspaceInput) String() string

String returns the string representation

func (*CreateWorkspaceInput) Validate 

func (s *CreateWorkspaceInput) Validate() error

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

type CreateWorkspaceOutput 

type CreateWorkspaceOutput struct {

	// The ARN of the workspace that was just created.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The status of the workspace that was just created (usually CREATING).
	//
	// Status is a required field
	Status *WorkspaceStatus `locationName:"status" type:"structure" required:"true"`

	// The generated ID of the workspace that was just created.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a CreateWorkspace operation.

func (CreateWorkspaceOutput) GoString 

func (s CreateWorkspaceOutput) GoString() string

GoString returns the string representation

func (*CreateWorkspaceOutput) SetArn 

func (s *CreateWorkspaceOutput) SetArn(v string) *CreateWorkspaceOutput

SetArn sets the Arn field's value.

func (*CreateWorkspaceOutput) SetStatus 

func (s *CreateWorkspaceOutput) SetStatus(v *WorkspaceStatus) *CreateWorkspaceOutput

SetStatus sets the Status field's value.

func (*CreateWorkspaceOutput) SetWorkspaceId 

func (s *CreateWorkspaceOutput) SetWorkspaceId(v string) *CreateWorkspaceOutput

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateWorkspaceOutput) String 

func (s CreateWorkspaceOutput) String() string

String returns the string representation

type DeleteWorkspaceInput 

type DeleteWorkspaceInput struct {

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the workspace to delete.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a DeleteWorkspace operation.

func (DeleteWorkspaceInput) GoString 

func (s DeleteWorkspaceInput) GoString() string

GoString returns the string representation

func (*DeleteWorkspaceInput) SetClientToken 

func (s *DeleteWorkspaceInput) SetClientToken(v string) *DeleteWorkspaceInput

SetClientToken sets the ClientToken field's value.

func (*DeleteWorkspaceInput) SetWorkspaceId 

func (s *DeleteWorkspaceInput) SetWorkspaceId(v string) *DeleteWorkspaceInput

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteWorkspaceInput) String 

func (s DeleteWorkspaceInput) String() string

String returns the string representation

func (*DeleteWorkspaceInput) Validate 

func (s *DeleteWorkspaceInput) Validate() error

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

type DeleteWorkspaceOutput 

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

func (DeleteWorkspaceOutput) GoString 

func (s DeleteWorkspaceOutput) GoString() string

GoString returns the string representation

func (DeleteWorkspaceOutput) String 

func (s DeleteWorkspaceOutput) String() string

String returns the string representation

type DescribeWorkspaceInput 

type DescribeWorkspaceInput struct {

	// The ID of the workspace to describe.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a DescribeWorkspace operation.

func (DescribeWorkspaceInput) GoString 

func (s DescribeWorkspaceInput) GoString() string

GoString returns the string representation

func (*DescribeWorkspaceInput) SetWorkspaceId 

func (s *DescribeWorkspaceInput) SetWorkspaceId(v string) *DescribeWorkspaceInput

SetWorkspaceId sets the WorkspaceId field's value.

func (DescribeWorkspaceInput) String 

func (s DescribeWorkspaceInput) String() string

String returns the string representation

func (*DescribeWorkspaceInput) Validate 

func (s *DescribeWorkspaceInput) Validate() error

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

type DescribeWorkspaceOutput 

type DescribeWorkspaceOutput struct {

	// The properties of the selected workspace.
	//
	// Workspace is a required field
	Workspace *WorkspaceDescription `locationName:"workspace" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeWorkspace operation.

func (DescribeWorkspaceOutput) GoString 

func (s DescribeWorkspaceOutput) GoString() string

GoString returns the string representation

func (*DescribeWorkspaceOutput) SetWorkspace 

func (s *DescribeWorkspaceOutput) SetWorkspace(v *WorkspaceDescription) *DescribeWorkspaceOutput

SetWorkspace sets the Workspace field's value.

func (DescribeWorkspaceOutput) String 

func (s DescribeWorkspaceOutput) String() string

String returns the string representation

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// Advice to clients on when the call can be safely retried.
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`
	// contains filtered or unexported fields
}

Unexpected error during processing of request.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation

type ListWorkspacesInput 

type ListWorkspacesInput struct {

	// Optional filter for workspace alias. Only the workspaces with aliases that
	// begin with this value will be returned.
	Alias *string `location:"querystring" locationName:"alias" min:"1" type:"string"`

	// Maximum results to return in response (default=100, maximum=1000).
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// Pagination token to request the next page in a paginated list. This token
	// is obtained from the output of the previous ListWorkspaces request.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a ListWorkspaces operation.

func (ListWorkspacesInput) GoString 

func (s ListWorkspacesInput) GoString() string

GoString returns the string representation

func (*ListWorkspacesInput) SetAlias 

func (s *ListWorkspacesInput) SetAlias(v string) *ListWorkspacesInput

SetAlias sets the Alias field's value.

func (*ListWorkspacesInput) SetMaxResults 

func (s *ListWorkspacesInput) SetMaxResults(v int64) *ListWorkspacesInput

SetMaxResults sets the MaxResults field's value.

func (*ListWorkspacesInput) SetNextToken 

func (s *ListWorkspacesInput) SetNextToken(v string) *ListWorkspacesInput

SetNextToken sets the NextToken field's value.

func (ListWorkspacesInput) String 

func (s ListWorkspacesInput) String() string

String returns the string representation

func (*ListWorkspacesInput) Validate 

func (s *ListWorkspacesInput) Validate() error

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

type ListWorkspacesOutput 

type ListWorkspacesOutput struct {

	// Pagination token to use when requesting the next page in this list.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The list of existing workspaces, including those undergoing creation or deletion.
	//
	// Workspaces is a required field
	Workspaces []*WorkspaceSummary `locationName:"workspaces" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a ListWorkspaces operation.

func (ListWorkspacesOutput) GoString 

func (s ListWorkspacesOutput) GoString() string

GoString returns the string representation

func (*ListWorkspacesOutput) SetNextToken 

func (s *ListWorkspacesOutput) SetNextToken(v string) *ListWorkspacesOutput

SetNextToken sets the NextToken field's value.

func (*ListWorkspacesOutput) SetWorkspaces 

func (s *ListWorkspacesOutput) SetWorkspaces(v []*WorkspaceSummary) *ListWorkspacesOutput

SetWorkspaces sets the Workspaces field's value.

func (ListWorkspacesOutput) String 

func (s ListWorkspacesOutput) String() string

String returns the string representation

type PrometheusService 

type PrometheusService struct {
	*client.Client
}

PrometheusService provides the API operation methods for making requests to Amazon Prometheus Service. See this package's package overview docs for details on the service.

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

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *PrometheusService

New creates a new instance of the PrometheusService client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a PrometheusService client from just a session.
svc := prometheusservice.New(mySession)

// Create a PrometheusService client with additional configuration
svc := prometheusservice.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*PrometheusService) CreateWorkspace 

func (c *PrometheusService) CreateWorkspace(input *CreateWorkspaceInput) (*CreateWorkspaceOutput, error)

CreateWorkspace API operation for Amazon Prometheus Service.

Creates a new AMP workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Prometheus Service's API operation CreateWorkspace for usage and error information.

Returned Error Types:

  • ThrottlingException Request was denied due to request throttling.

  • ConflictException Updating or deleting a resource can cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • InternalServerException Unexpected error during processing of request.

  • ServiceQuotaExceededException Request would cause a service quota to be exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateWorkspace

func (*PrometheusService) CreateWorkspaceRequest 

func (c *PrometheusService) CreateWorkspaceRequest(input *CreateWorkspaceInput) (req *request.Request, output *CreateWorkspaceOutput)

CreateWorkspaceRequest generates a "aws/request.Request" representing the client's request for the CreateWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWorkspace for more information on using the CreateWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateWorkspaceRequest method.
req, resp := client.CreateWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateWorkspace

func (*PrometheusService) CreateWorkspaceWithContext 

func (c *PrometheusService) CreateWorkspaceWithContext(ctx aws.Context, input *CreateWorkspaceInput, opts ...request.Option) (*CreateWorkspaceOutput, error)

CreateWorkspaceWithContext is the same as CreateWorkspace with the addition of the ability to pass a context and additional request options.

See CreateWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PrometheusService) DeleteWorkspace 

func (c *PrometheusService) DeleteWorkspace(input *DeleteWorkspaceInput) (*DeleteWorkspaceOutput, error)

DeleteWorkspace API operation for Amazon Prometheus Service.

Deletes an AMP workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Prometheus Service's API operation DeleteWorkspace for usage and error information.

Returned Error Types:

  • ThrottlingException Request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • ResourceNotFoundException Request references a resource which does not exist.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • InternalServerException Unexpected error during processing of request.

See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteWorkspace

func (*PrometheusService) DeleteWorkspaceRequest 

func (c *PrometheusService) DeleteWorkspaceRequest(input *DeleteWorkspaceInput) (req *request.Request, output *DeleteWorkspaceOutput)

DeleteWorkspaceRequest generates a "aws/request.Request" representing the client's request for the DeleteWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWorkspace for more information on using the DeleteWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteWorkspaceRequest method.
req, resp := client.DeleteWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteWorkspace

func (*PrometheusService) DeleteWorkspaceWithContext 

func (c *PrometheusService) DeleteWorkspaceWithContext(ctx aws.Context, input *DeleteWorkspaceInput, opts ...request.Option) (*DeleteWorkspaceOutput, error)

DeleteWorkspaceWithContext is the same as DeleteWorkspace with the addition of the ability to pass a context and additional request options.

See DeleteWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PrometheusService) DescribeWorkspace 

func (c *PrometheusService) DescribeWorkspace(input *DescribeWorkspaceInput) (*DescribeWorkspaceOutput, error)

DescribeWorkspace API operation for Amazon Prometheus Service.

Describes an existing AMP workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Prometheus Service's API operation DescribeWorkspace for usage and error information.

Returned Error Types:

  • ThrottlingException Request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • ResourceNotFoundException Request references a resource which does not exist.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • InternalServerException Unexpected error during processing of request.

See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeWorkspace

func (*PrometheusService) DescribeWorkspaceRequest 

func (c *PrometheusService) DescribeWorkspaceRequest(input *DescribeWorkspaceInput) (req *request.Request, output *DescribeWorkspaceOutput)

DescribeWorkspaceRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkspace for more information on using the DescribeWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkspaceRequest method.
req, resp := client.DescribeWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeWorkspace

func (*PrometheusService) DescribeWorkspaceWithContext 

func (c *PrometheusService) DescribeWorkspaceWithContext(ctx aws.Context, input *DescribeWorkspaceInput, opts ...request.Option) (*DescribeWorkspaceOutput, error)

DescribeWorkspaceWithContext is the same as DescribeWorkspace with the addition of the ability to pass a context and additional request options.

See DescribeWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PrometheusService) ListWorkspaces 

func (c *PrometheusService) ListWorkspaces(input *ListWorkspacesInput) (*ListWorkspacesOutput, error)

ListWorkspaces API operation for Amazon Prometheus Service.

Lists all AMP workspaces, including workspaces being created or deleted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Prometheus Service's API operation ListWorkspaces for usage and error information.

Returned Error Types:

  • ThrottlingException Request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • InternalServerException Unexpected error during processing of request.

See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListWorkspaces

func (*PrometheusService) ListWorkspacesPages 

func (c *PrometheusService) ListWorkspacesPages(input *ListWorkspacesInput, fn func(*ListWorkspacesOutput, bool) bool) error

ListWorkspacesPages iterates over the pages of a ListWorkspaces operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWorkspaces method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListWorkspaces operation.
pageNum := 0
err := client.ListWorkspacesPages(params,
    func(page *prometheusservice.ListWorkspacesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PrometheusService) ListWorkspacesPagesWithContext 

func (c *PrometheusService) ListWorkspacesPagesWithContext(ctx aws.Context, input *ListWorkspacesInput, fn func(*ListWorkspacesOutput, bool) bool, opts ...request.Option) error

ListWorkspacesPagesWithContext same as ListWorkspacesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PrometheusService) ListWorkspacesRequest 

func (c *PrometheusService) ListWorkspacesRequest(input *ListWorkspacesInput) (req *request.Request, output *ListWorkspacesOutput)

ListWorkspacesRequest generates a "aws/request.Request" representing the client's request for the ListWorkspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWorkspaces for more information on using the ListWorkspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListWorkspacesRequest method.
req, resp := client.ListWorkspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListWorkspaces

func (*PrometheusService) ListWorkspacesWithContext 

func (c *PrometheusService) ListWorkspacesWithContext(ctx aws.Context, input *ListWorkspacesInput, opts ...request.Option) (*ListWorkspacesOutput, error)

ListWorkspacesWithContext is the same as ListWorkspaces with the addition of the ability to pass a context and additional request options.

See ListWorkspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*PrometheusService) UpdateWorkspaceAlias 

func (c *PrometheusService) UpdateWorkspaceAlias(input *UpdateWorkspaceAliasInput) (*UpdateWorkspaceAliasOutput, error)

UpdateWorkspaceAlias API operation for Amazon Prometheus Service.

Updates an AMP workspace alias.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Prometheus Service's API operation UpdateWorkspaceAlias for usage and error information.

Returned Error Types:

  • ThrottlingException Request was denied due to request throttling.

  • ConflictException Updating or deleting a resource can cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an AWS service.

  • ResourceNotFoundException Request references a resource which does not exist.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • InternalServerException Unexpected error during processing of request.

  • ServiceQuotaExceededException Request would cause a service quota to be exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateWorkspaceAlias

func (*PrometheusService) UpdateWorkspaceAliasRequest 

func (c *PrometheusService) UpdateWorkspaceAliasRequest(input *UpdateWorkspaceAliasInput) (req *request.Request, output *UpdateWorkspaceAliasOutput)

UpdateWorkspaceAliasRequest generates a "aws/request.Request" representing the client's request for the UpdateWorkspaceAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWorkspaceAlias for more information on using the UpdateWorkspaceAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateWorkspaceAliasRequest method.
req, resp := client.UpdateWorkspaceAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateWorkspaceAlias

func (*PrometheusService) UpdateWorkspaceAliasWithContext 

func (c *PrometheusService) UpdateWorkspaceAliasWithContext(ctx aws.Context, input *UpdateWorkspaceAliasInput, opts ...request.Option) (*UpdateWorkspaceAliasOutput, error)

UpdateWorkspaceAliasWithContext is the same as UpdateWorkspaceAlias with the addition of the ability to pass a context and additional request options.

See UpdateWorkspaceAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// Identifier of the resource affected.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// Type of the resource affected.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request references a resource which does not exist.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// Service Quotas requirement to identify originating quota.
	//
	// QuotaCode is a required field
	QuotaCode *string `locationName:"quotaCode" type:"string" required:"true"`

	// Identifier of the resource affected.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// Type of the resource affected.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`

	// Service Quotas requirement to identify originating service.
	//
	// ServiceCode is a required field
	ServiceCode *string `locationName:"serviceCode" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request would cause a service quota to be exceeded.

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// Service Quotas requirement to identify originating quota.
	QuotaCode *string `locationName:"quotaCode" type:"string"`

	// Advice to clients on when the call can be safely retried.
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`

	// Service Quotas requirement to identify originating service.
	ServiceCode *string `locationName:"serviceCode" type:"string"`
	// contains filtered or unexported fields
}

Request was denied due to request throttling.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation

type UpdateWorkspaceAliasInput 

type UpdateWorkspaceAliasInput struct {

	// The new alias of the workspace.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// Optional, unique, case-sensitive, user-provided identifier to ensure the
	// idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the workspace being updated.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of an UpdateWorkspaceAlias operation.

func (UpdateWorkspaceAliasInput) GoString 

func (s UpdateWorkspaceAliasInput) GoString() string

GoString returns the string representation

func (*UpdateWorkspaceAliasInput) SetAlias 

func (s *UpdateWorkspaceAliasInput) SetAlias(v string) *UpdateWorkspaceAliasInput

SetAlias sets the Alias field's value.

func (*UpdateWorkspaceAliasInput) SetClientToken 

func (s *UpdateWorkspaceAliasInput) SetClientToken(v string) *UpdateWorkspaceAliasInput

SetClientToken sets the ClientToken field's value.

func (*UpdateWorkspaceAliasInput) SetWorkspaceId 

func (s *UpdateWorkspaceAliasInput) SetWorkspaceId(v string) *UpdateWorkspaceAliasInput

SetWorkspaceId sets the WorkspaceId field's value.

func (UpdateWorkspaceAliasInput) String 

func (s UpdateWorkspaceAliasInput) String() string

String returns the string representation

func (*UpdateWorkspaceAliasInput) Validate 

func (s *UpdateWorkspaceAliasInput) Validate() error

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

type UpdateWorkspaceAliasOutput 

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

func (UpdateWorkspaceAliasOutput) GoString 

func (s UpdateWorkspaceAliasOutput) GoString() string

GoString returns the string representation

func (UpdateWorkspaceAliasOutput) String 

func (s UpdateWorkspaceAliasOutput) String() string

String returns the string representation

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The field that caused the error, if applicable. If more than one field caused
	// the error, pick one and elaborate in the message.
	FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list"`

	// Description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// Reason the request failed validation.
	//
	// Reason is a required field
	Reason *string `locationName:"reason" type:"string" required:"true" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by an AWS service.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation

type ValidationExceptionField 

type ValidationExceptionField struct {

	// Message describing why the field failed validation.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The field name.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Stores information about a field passed inside a request that resulted in an exception.

func (ValidationExceptionField) GoString 

func (s ValidationExceptionField) GoString() string

GoString returns the string representation

func (*ValidationExceptionField) SetMessage 

func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName 

func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField

SetName sets the Name field's value.

func (ValidationExceptionField) String 

func (s ValidationExceptionField) String() string

String returns the string representation

type WorkspaceDescription 

type WorkspaceDescription struct {

	// Alias of this workspace.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of this workspace.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The time when the workspace was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"`

	// Prometheus endpoint URI.
	PrometheusEndpoint *string `locationName:"prometheusEndpoint" min:"1" type:"string"`

	// The status of this workspace.
	//
	// Status is a required field
	Status *WorkspaceStatus `locationName:"status" type:"structure" required:"true"`

	// Unique string identifying this workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the properties of a workspace.

func (WorkspaceDescription) GoString 

func (s WorkspaceDescription) GoString() string

GoString returns the string representation

func (*WorkspaceDescription) SetAlias 

func (s *WorkspaceDescription) SetAlias(v string) *WorkspaceDescription

SetAlias sets the Alias field's value.

func (*WorkspaceDescription) SetArn 

func (s *WorkspaceDescription) SetArn(v string) *WorkspaceDescription

SetArn sets the Arn field's value.

func (*WorkspaceDescription) SetCreatedAt 

func (s *WorkspaceDescription) SetCreatedAt(v time.Time) *WorkspaceDescription

SetCreatedAt sets the CreatedAt field's value.

func (*WorkspaceDescription) SetPrometheusEndpoint 

func (s *WorkspaceDescription) SetPrometheusEndpoint(v string) *WorkspaceDescription

SetPrometheusEndpoint sets the PrometheusEndpoint field's value.

func (*WorkspaceDescription) SetStatus 

func (s *WorkspaceDescription) SetStatus(v *WorkspaceStatus) *WorkspaceDescription

SetStatus sets the Status field's value.

func (*WorkspaceDescription) SetWorkspaceId 

func (s *WorkspaceDescription) SetWorkspaceId(v string) *WorkspaceDescription

SetWorkspaceId sets the WorkspaceId field's value.

func (WorkspaceDescription) String 

func (s WorkspaceDescription) String() string

String returns the string representation

type WorkspaceStatus 

type WorkspaceStatus struct {

	// Status code of this workspace.
	//
	// StatusCode is a required field
	StatusCode *string `locationName:"statusCode" type:"string" required:"true" enum:"WorkspaceStatusCode"`
	// contains filtered or unexported fields
}

Represents the status of a workspace.

func (WorkspaceStatus) GoString 

func (s WorkspaceStatus) GoString() string

GoString returns the string representation

func (*WorkspaceStatus) SetStatusCode 

func (s *WorkspaceStatus) SetStatusCode(v string) *WorkspaceStatus

SetStatusCode sets the StatusCode field's value.

func (WorkspaceStatus) String 

func (s WorkspaceStatus) String() string

String returns the string representation

type WorkspaceSummary 

type WorkspaceSummary struct {

	// Alias of this workspace.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// The AmazonResourceName of this workspace.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The time when the workspace was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"`

	// The status of this workspace.
	//
	// Status is a required field
	Status *WorkspaceStatus `locationName:"status" type:"structure" required:"true"`

	// Unique string identifying this workspace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a summary of the properties of a workspace.

func (WorkspaceSummary) GoString 

func (s WorkspaceSummary) GoString() string

GoString returns the string representation

func (*WorkspaceSummary) SetAlias 

func (s *WorkspaceSummary) SetAlias(v string) *WorkspaceSummary

SetAlias sets the Alias field's value.

func (*WorkspaceSummary) SetArn 

func (s *WorkspaceSummary) SetArn(v string) *WorkspaceSummary

SetArn sets the Arn field's value.

func (*WorkspaceSummary) SetCreatedAt 

func (s *WorkspaceSummary) SetCreatedAt(v time.Time) *WorkspaceSummary

SetCreatedAt sets the CreatedAt field's value.

func (*WorkspaceSummary) SetStatus 

func (s *WorkspaceSummary) SetStatus(v *WorkspaceStatus) *WorkspaceSummary

SetStatus sets the Status field's value.

func (*WorkspaceSummary) SetWorkspaceId 

func (s *WorkspaceSummary) SetWorkspaceId(v string) *WorkspaceSummary

SetWorkspaceId sets the WorkspaceId field's value.

func (WorkspaceSummary) String 

func (s WorkspaceSummary) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package prometheusserviceiface provides an interface to enable mocking the Amazon Prometheus Service service client for testing your code.
 Package prometheusserviceiface provides an interface to enable mocking the Amazon Prometheus Service 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.