prometheusservice

package
v1.51.30 Latest Latest
Warning

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

Go to latest
Published: Apr 26, 2024 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 is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor container environments at scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data model and query language that you use today to monitor the performance of your containerized workloads, and also enjoy improved scalability, availability, and security without having to manage the underlying infrastructure.

For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus (https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html) User Guide.

Amazon Managed Service for Prometheus includes two APIs.

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 (
	// AlertManagerDefinitionStatusCodeCreating is a AlertManagerDefinitionStatusCode enum value
	AlertManagerDefinitionStatusCodeCreating = "CREATING"

	// AlertManagerDefinitionStatusCodeActive is a AlertManagerDefinitionStatusCode enum value
	AlertManagerDefinitionStatusCodeActive = "ACTIVE"

	// AlertManagerDefinitionStatusCodeUpdating is a AlertManagerDefinitionStatusCode enum value
	AlertManagerDefinitionStatusCodeUpdating = "UPDATING"

	// AlertManagerDefinitionStatusCodeDeleting is a AlertManagerDefinitionStatusCode enum value
	AlertManagerDefinitionStatusCodeDeleting = "DELETING"

	// AlertManagerDefinitionStatusCodeCreationFailed is a AlertManagerDefinitionStatusCode enum value
	AlertManagerDefinitionStatusCodeCreationFailed = "CREATION_FAILED"

	// AlertManagerDefinitionStatusCodeUpdateFailed is a AlertManagerDefinitionStatusCode enum value
	AlertManagerDefinitionStatusCodeUpdateFailed = "UPDATE_FAILED"
)

State of an AlertManagerDefinition.

View Source
const (
	// LoggingConfigurationStatusCodeCreating is a LoggingConfigurationStatusCode enum value
	LoggingConfigurationStatusCodeCreating = "CREATING"

	// LoggingConfigurationStatusCodeActive is a LoggingConfigurationStatusCode enum value
	LoggingConfigurationStatusCodeActive = "ACTIVE"

	// LoggingConfigurationStatusCodeUpdating is a LoggingConfigurationStatusCode enum value
	LoggingConfigurationStatusCodeUpdating = "UPDATING"

	// LoggingConfigurationStatusCodeDeleting is a LoggingConfigurationStatusCode enum value
	LoggingConfigurationStatusCodeDeleting = "DELETING"

	// LoggingConfigurationStatusCodeCreationFailed is a LoggingConfigurationStatusCode enum value
	LoggingConfigurationStatusCodeCreationFailed = "CREATION_FAILED"

	// LoggingConfigurationStatusCodeUpdateFailed is a LoggingConfigurationStatusCode enum value
	LoggingConfigurationStatusCodeUpdateFailed = "UPDATE_FAILED"
)

State of a logging configuration.

View Source
const (
	// RuleGroupsNamespaceStatusCodeCreating is a RuleGroupsNamespaceStatusCode enum value
	RuleGroupsNamespaceStatusCodeCreating = "CREATING"

	// RuleGroupsNamespaceStatusCodeActive is a RuleGroupsNamespaceStatusCode enum value
	RuleGroupsNamespaceStatusCodeActive = "ACTIVE"

	// RuleGroupsNamespaceStatusCodeUpdating is a RuleGroupsNamespaceStatusCode enum value
	RuleGroupsNamespaceStatusCodeUpdating = "UPDATING"

	// RuleGroupsNamespaceStatusCodeDeleting is a RuleGroupsNamespaceStatusCode enum value
	RuleGroupsNamespaceStatusCodeDeleting = "DELETING"

	// RuleGroupsNamespaceStatusCodeCreationFailed is a RuleGroupsNamespaceStatusCode enum value
	RuleGroupsNamespaceStatusCodeCreationFailed = "CREATION_FAILED"

	// RuleGroupsNamespaceStatusCodeUpdateFailed is a RuleGroupsNamespaceStatusCode enum value
	RuleGroupsNamespaceStatusCodeUpdateFailed = "UPDATE_FAILED"
)

State of a namespace.

View Source
const (
	// ScraperStatusCodeCreating is a ScraperStatusCode enum value
	ScraperStatusCodeCreating = "CREATING"

	// ScraperStatusCodeActive is a ScraperStatusCode enum value
	ScraperStatusCodeActive = "ACTIVE"

	// ScraperStatusCodeDeleting is a ScraperStatusCode enum value
	ScraperStatusCodeDeleting = "DELETING"

	// ScraperStatusCodeCreationFailed is a ScraperStatusCode enum value
	ScraperStatusCodeCreationFailed = "CREATION_FAILED"

	// ScraperStatusCodeDeletionFailed is a ScraperStatusCode enum value
	ScraperStatusCodeDeletionFailed = "DELETION_FAILED"
)

State of a scraper.

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".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The request would cause an inconsistent state.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An unexpected error occurred during the processing of the request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The request references a resources that doesn't exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// Completing the request would cause a service quota to be exceeded.
	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 input fails to satisfy the constraints specified by an Amazon Web Services
	// 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 AlertManagerDefinitionStatusCode_Values added in v1.40.52

func AlertManagerDefinitionStatusCode_Values() []string

AlertManagerDefinitionStatusCode_Values returns all elements of the AlertManagerDefinitionStatusCode enum

func LoggingConfigurationStatusCode_Values added in v1.44.76

func LoggingConfigurationStatusCode_Values() []string

LoggingConfigurationStatusCode_Values returns all elements of the LoggingConfigurationStatusCode enum

func RuleGroupsNamespaceStatusCode_Values added in v1.40.52

func RuleGroupsNamespaceStatusCode_Values() []string

RuleGroupsNamespaceStatusCode_Values returns all elements of the RuleGroupsNamespaceStatusCode enum

func ScraperStatusCode_Values added in v1.48.4

func ScraperStatusCode_Values() []string

ScraperStatusCode_Values returns all elements of the ScraperStatusCode enum

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
}

You do 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AlertManagerDefinitionDescription added in v1.40.52

type AlertManagerDefinitionDescription struct {

	// The date and time that the alert manager definition was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"`

	// The actual alert manager definition.
	//
	// For details about the alert manager definition, see AlertManagedDefinitionData
	// (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html).
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `locationName:"data" type:"blob" required:"true"`

	// The date and time that the alert manager definition was most recently changed.
	//
	// ModifiedAt is a required field
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp" required:"true"`

	// A structure that displays the current status of the alert manager definition..
	//
	// Status is a required field
	Status *AlertManagerDefinitionStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The details of an alert manager definition.

func (AlertManagerDefinitionDescription) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlertManagerDefinitionDescription) SetCreatedAt added in v1.40.52

SetCreatedAt sets the CreatedAt field's value.

func (*AlertManagerDefinitionDescription) SetData added in v1.40.52

SetData sets the Data field's value.

func (*AlertManagerDefinitionDescription) SetModifiedAt added in v1.40.52

SetModifiedAt sets the ModifiedAt field's value.

func (*AlertManagerDefinitionDescription) SetStatus added in v1.40.52

SetStatus sets the Status field's value.

func (AlertManagerDefinitionDescription) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AlertManagerDefinitionStatus added in v1.40.52

type AlertManagerDefinitionStatus struct {

	// The current status of the alert manager.
	//
	// StatusCode is a required field
	StatusCode *string `locationName:"statusCode" type:"string" required:"true" enum:"AlertManagerDefinitionStatusCode"`

	// If there is a failure, the reason for the failure.
	StatusReason *string `locationName:"statusReason" type:"string"`
	// contains filtered or unexported fields
}

The status of the alert manager.

func (AlertManagerDefinitionStatus) GoString added in v1.40.52

func (s AlertManagerDefinitionStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AlertManagerDefinitionStatus) SetStatusCode added in v1.40.52

SetStatusCode sets the StatusCode field's value.

func (*AlertManagerDefinitionStatus) SetStatusReason added in v1.40.52

SetStatusReason sets the StatusReason field's value.

func (AlertManagerDefinitionStatus) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AmpConfiguration added in v1.48.4

type AmpConfiguration struct {

	// ARN of the Amazon Managed Service for Prometheus workspace.
	//
	// WorkspaceArn is a required field
	WorkspaceArn *string `locationName:"workspaceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.

func (AmpConfiguration) GoString added in v1.48.4

func (s AmpConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AmpConfiguration) SetWorkspaceArn added in v1.48.4

func (s *AmpConfiguration) SetWorkspaceArn(v string) *AmpConfiguration

SetWorkspaceArn sets the WorkspaceArn field's value.

func (AmpConfiguration) String added in v1.48.4

func (s AmpConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AmpConfiguration) Validate added in v1.48.4

func (s *AmpConfiguration) Validate() error

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

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
}

The request would 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAlertManagerDefinitionInput added in v1.40.52

type CreateAlertManagerDefinitionInput struct {

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The alert manager definition to add. A base64-encoded version of the YAML
	// alert manager definition file.
	//
	// For details about the alert manager definition, see AlertManagedDefinitionData
	// (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html).
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `locationName:"data" type:"blob" required:"true"`

	// The ID of the workspace to add the alert manager definition to.
	//
	// 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 CreateAlertManagerDefinition operation.

func (CreateAlertManagerDefinitionInput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAlertManagerDefinitionInput) SetClientToken added in v1.40.52

SetClientToken sets the ClientToken field's value.

func (*CreateAlertManagerDefinitionInput) SetData added in v1.40.52

SetData sets the Data field's value.

func (*CreateAlertManagerDefinitionInput) SetWorkspaceId added in v1.40.52

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateAlertManagerDefinitionInput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAlertManagerDefinitionInput) Validate added in v1.40.52

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

type CreateAlertManagerDefinitionOutput added in v1.40.52

type CreateAlertManagerDefinitionOutput struct {

	// A structure that displays the current status of the alert manager definition.
	//
	// Status is a required field
	Status *AlertManagerDefinitionStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a CreateAlertManagerDefinition operation.

func (CreateAlertManagerDefinitionOutput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAlertManagerDefinitionOutput) SetStatus added in v1.40.52

SetStatus sets the Status field's value.

func (CreateAlertManagerDefinitionOutput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLoggingConfigurationInput added in v1.44.76

type CreateLoggingConfigurationInput struct {

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The ARN of the CloudWatch log group to which the vended log data will be
	// published. This log group must exist prior to calling this API.
	//
	// LogGroupArn is a required field
	LogGroupArn *string `locationName:"logGroupArn" type:"string" required:"true"`

	// The ID of the workspace to create the logging configuration for.
	//
	// 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 CreateLoggingConfiguration operation.

func (CreateLoggingConfigurationInput) GoString added in v1.44.76

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLoggingConfigurationInput) SetClientToken added in v1.44.76

SetClientToken sets the ClientToken field's value.

func (*CreateLoggingConfigurationInput) SetLogGroupArn added in v1.44.76

SetLogGroupArn sets the LogGroupArn field's value.

func (*CreateLoggingConfigurationInput) SetWorkspaceId added in v1.44.76

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateLoggingConfigurationInput) String added in v1.44.76

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLoggingConfigurationInput) Validate added in v1.44.76

func (s *CreateLoggingConfigurationInput) Validate() error

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

type CreateLoggingConfigurationOutput added in v1.44.76

type CreateLoggingConfigurationOutput struct {

	// A structure that displays the current status of the logging configuration.
	//
	// Status is a required field
	Status *LoggingConfigurationStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a CreateLoggingConfiguration operation.

func (CreateLoggingConfigurationOutput) GoString added in v1.44.76

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLoggingConfigurationOutput) SetStatus added in v1.44.76

SetStatus sets the Status field's value.

func (CreateLoggingConfigurationOutput) String added in v1.44.76

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateRuleGroupsNamespaceInput added in v1.40.52

type CreateRuleGroupsNamespaceInput struct {

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The rules file to use in the new namespace.
	//
	// Contains the base64-encoded version of the YAML rules file.
	//
	// For details about the rule groups namespace structure, see RuleGroupsNamespaceData
	// (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html).
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `locationName:"data" type:"blob" required:"true"`

	// The name for the new rule groups namespace.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The list of tag keys and values to associate with the rule groups namespace.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The ID of the workspace to add the rule groups namespace.
	//
	// 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 CreateRuleGroupsNamespace operation.

func (CreateRuleGroupsNamespaceInput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRuleGroupsNamespaceInput) SetClientToken added in v1.40.52

SetClientToken sets the ClientToken field's value.

func (*CreateRuleGroupsNamespaceInput) SetData added in v1.40.52

SetData sets the Data field's value.

func (*CreateRuleGroupsNamespaceInput) SetName added in v1.40.52

SetName sets the Name field's value.

func (*CreateRuleGroupsNamespaceInput) SetTags added in v1.40.52

SetTags sets the Tags field's value.

func (*CreateRuleGroupsNamespaceInput) SetWorkspaceId added in v1.40.52

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateRuleGroupsNamespaceInput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRuleGroupsNamespaceInput) Validate added in v1.40.52

func (s *CreateRuleGroupsNamespaceInput) Validate() error

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

type CreateRuleGroupsNamespaceOutput added in v1.40.52

type CreateRuleGroupsNamespaceOutput struct {

	// The Amazon Resource Name (ARN) of the new rule groups namespace.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The name of the new rule groups namespace.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// A structure that returns the current status of the rule groups namespace.
	//
	// Status is a required field
	Status *RuleGroupsNamespaceStatus `locationName:"status" type:"structure" required:"true"`

	// The list of tag keys and values that are associated with the namespace.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Represents the output of a CreateRuleGroupsNamespace operation.

func (CreateRuleGroupsNamespaceOutput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRuleGroupsNamespaceOutput) SetArn added in v1.40.52

SetArn sets the Arn field's value.

func (*CreateRuleGroupsNamespaceOutput) SetName added in v1.40.52

SetName sets the Name field's value.

func (*CreateRuleGroupsNamespaceOutput) SetStatus added in v1.40.52

SetStatus sets the Status field's value.

func (*CreateRuleGroupsNamespaceOutput) SetTags added in v1.40.52

SetTags sets the Tags field's value.

func (CreateRuleGroupsNamespaceOutput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateScraperInput added in v1.48.4

type CreateScraperInput struct {

	// (optional) a name to associate with the scraper. This is for your use, and
	// does not need to be unique.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// (Optional) A unique, case-sensitive identifier that you can provide to ensure
	// the idempotency of the request.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The Amazon Managed Service for Prometheus workspace to send metrics to.
	//
	// Destination is a required field
	Destination *Destination `locationName:"destination" type:"structure" required:"true"`

	// The configuration file to use in the new scraper. For more information, see
	// Scraper configuration (prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration)
	// in the Amazon Managed Service for Prometheus User Guide.
	//
	// ScrapeConfiguration is a required field
	ScrapeConfiguration *ScrapeConfiguration `locationName:"scrapeConfiguration" type:"structure" required:"true"`

	// The Amazon EKS cluster from which the scraper will collect metrics.
	//
	// Source is a required field
	Source *Source `locationName:"source" type:"structure" required:"true"`

	// (Optional) The list of tag keys and values to associate with the scraper.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Represents the input of a CreateScraper operation.

func (CreateScraperInput) GoString added in v1.48.4

func (s CreateScraperInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScraperInput) SetAlias added in v1.48.4

SetAlias sets the Alias field's value.

func (*CreateScraperInput) SetClientToken added in v1.48.4

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

SetClientToken sets the ClientToken field's value.

func (*CreateScraperInput) SetDestination added in v1.48.4

func (s *CreateScraperInput) SetDestination(v *Destination) *CreateScraperInput

SetDestination sets the Destination field's value.

func (*CreateScraperInput) SetScrapeConfiguration added in v1.48.4

func (s *CreateScraperInput) SetScrapeConfiguration(v *ScrapeConfiguration) *CreateScraperInput

SetScrapeConfiguration sets the ScrapeConfiguration field's value.

func (*CreateScraperInput) SetSource added in v1.48.4

func (s *CreateScraperInput) SetSource(v *Source) *CreateScraperInput

SetSource sets the Source field's value.

func (*CreateScraperInput) SetTags added in v1.48.4

func (s *CreateScraperInput) SetTags(v map[string]*string) *CreateScraperInput

SetTags sets the Tags field's value.

func (CreateScraperInput) String added in v1.48.4

func (s CreateScraperInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScraperInput) Validate added in v1.48.4

func (s *CreateScraperInput) Validate() error

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

type CreateScraperOutput added in v1.48.4

type CreateScraperOutput struct {

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

	// The ID of the new scraper.
	//
	// ScraperId is a required field
	ScraperId *string `locationName:"scraperId" min:"1" type:"string" required:"true"`

	// A structure that displays the current status of the scraper.
	//
	// Status is a required field
	Status *ScraperStatus `locationName:"status" type:"structure" required:"true"`

	// The list of tag keys and values that are associated with the scraper.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Represents the output of a CreateScraper operation.

func (CreateScraperOutput) GoString added in v1.48.4

func (s CreateScraperOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateScraperOutput) SetArn added in v1.48.4

SetArn sets the Arn field's value.

func (*CreateScraperOutput) SetScraperId added in v1.48.4

func (s *CreateScraperOutput) SetScraperId(v string) *CreateScraperOutput

SetScraperId sets the ScraperId field's value.

func (*CreateScraperOutput) SetStatus added in v1.48.4

SetStatus sets the Status field's value.

func (*CreateScraperOutput) SetTags added in v1.48.4

SetTags sets the Tags field's value.

func (CreateScraperOutput) String added in v1.48.4

func (s CreateScraperOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkspaceInput

type CreateWorkspaceInput struct {

	// An alias that you assign to this workspace to help you identify it. It does
	// not need to be unique.
	//
	// Blank spaces at the beginning or end of the alias that you specify will be
	// trimmed from the value used.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// (optional) The ARN for a customer managed KMS key to use for encrypting data
	// within your workspace. For more information about using your own key in your
	// workspace, see Encryption at rest (https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html)
	// in the Amazon Managed Service for Prometheus User Guide.
	KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"`

	// The list of tag keys and values to associate with the workspace.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceInput) SetAlias

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) SetKmsKeyArn added in v1.49.8

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

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*CreateWorkspaceInput) SetTags added in v1.40.38

SetTags sets the Tags field's value.

func (CreateWorkspaceInput) String

func (s CreateWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 for the new workspace.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// (optional) If the workspace was created with a customer managed KMS key,
	// the ARN for the key used.
	KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"`

	// The current status of the new workspace. Immediately after you create the
	// workspace, the status is usually CREATING.
	//
	// Status is a required field
	Status *WorkspaceStatus `locationName:"status" type:"structure" required:"true"`

	// The list of tag keys and values that are associated with the workspace.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The unique ID for the new workspace.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceOutput) SetArn

SetArn sets the Arn field's value.

func (*CreateWorkspaceOutput) SetKmsKeyArn added in v1.49.8

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*CreateWorkspaceOutput) SetStatus

SetStatus sets the Status field's value.

func (*CreateWorkspaceOutput) SetTags added in v1.40.38

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAlertManagerDefinitionInput added in v1.40.52

type DeleteAlertManagerDefinitionInput struct {

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the workspace to delete the alert manager definition from.
	//
	// 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 DeleteAlertManagerDefinition operation.

func (DeleteAlertManagerDefinitionInput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAlertManagerDefinitionInput) SetClientToken added in v1.40.52

SetClientToken sets the ClientToken field's value.

func (*DeleteAlertManagerDefinitionInput) SetWorkspaceId added in v1.40.52

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteAlertManagerDefinitionInput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAlertManagerDefinitionInput) Validate added in v1.40.52

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

type DeleteAlertManagerDefinitionOutput added in v1.40.52

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

func (DeleteAlertManagerDefinitionOutput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAlertManagerDefinitionOutput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteLoggingConfigurationInput added in v1.44.76

type DeleteLoggingConfigurationInput struct {

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the workspace containing the logging configuration 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 DeleteLoggingConfiguration operation.

func (DeleteLoggingConfigurationInput) GoString added in v1.44.76

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLoggingConfigurationInput) SetClientToken added in v1.44.76

SetClientToken sets the ClientToken field's value.

func (*DeleteLoggingConfigurationInput) SetWorkspaceId added in v1.44.76

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteLoggingConfigurationInput) String added in v1.44.76

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLoggingConfigurationInput) Validate added in v1.44.76

func (s *DeleteLoggingConfigurationInput) Validate() error

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

type DeleteLoggingConfigurationOutput added in v1.44.76

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

func (DeleteLoggingConfigurationOutput) GoString added in v1.44.76

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLoggingConfigurationOutput) String added in v1.44.76

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteRuleGroupsNamespaceInput added in v1.40.52

type DeleteRuleGroupsNamespaceInput struct {

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The name of the rule groups namespace to delete.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`

	// The ID of the workspace containing the rule groups namespace and definition
	// 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 DeleteRuleGroupsNamespace operation.

func (DeleteRuleGroupsNamespaceInput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRuleGroupsNamespaceInput) SetClientToken added in v1.40.52

SetClientToken sets the ClientToken field's value.

func (*DeleteRuleGroupsNamespaceInput) SetName added in v1.40.52

SetName sets the Name field's value.

func (*DeleteRuleGroupsNamespaceInput) SetWorkspaceId added in v1.40.52

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteRuleGroupsNamespaceInput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRuleGroupsNamespaceInput) Validate added in v1.40.52

func (s *DeleteRuleGroupsNamespaceInput) Validate() error

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

type DeleteRuleGroupsNamespaceOutput added in v1.40.52

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

func (DeleteRuleGroupsNamespaceOutput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteRuleGroupsNamespaceOutput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteScraperInput added in v1.48.4

type DeleteScraperInput struct {

	// (Optional) A unique, case-sensitive identifier that you can provide to ensure
	// the idempotency of the request.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

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

Represents the input of a DeleteScraper operation.

func (DeleteScraperInput) GoString added in v1.48.4

func (s DeleteScraperInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScraperInput) SetClientToken added in v1.48.4

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

SetClientToken sets the ClientToken field's value.

func (*DeleteScraperInput) SetScraperId added in v1.48.4

func (s *DeleteScraperInput) SetScraperId(v string) *DeleteScraperInput

SetScraperId sets the ScraperId field's value.

func (DeleteScraperInput) String added in v1.48.4

func (s DeleteScraperInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScraperInput) Validate added in v1.48.4

func (s *DeleteScraperInput) Validate() error

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

type DeleteScraperOutput added in v1.48.4

type DeleteScraperOutput struct {

	// The ID of the scraper to delete.
	//
	// ScraperId is a required field
	ScraperId *string `locationName:"scraperId" min:"1" type:"string" required:"true"`

	// The current status of the scraper.
	//
	// Status is a required field
	Status *ScraperStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a DeleteScraper operation.

func (DeleteScraperOutput) GoString added in v1.48.4

func (s DeleteScraperOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteScraperOutput) SetScraperId added in v1.48.4

func (s *DeleteScraperOutput) SetScraperId(v string) *DeleteScraperOutput

SetScraperId sets the ScraperId field's value.

func (*DeleteScraperOutput) SetStatus added in v1.48.4

SetStatus sets the Status field's value.

func (DeleteScraperOutput) String added in v1.48.4

func (s DeleteScraperOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkspaceInput

type DeleteWorkspaceInput struct {

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWorkspaceOutput) String

func (s DeleteWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAlertManagerDefinitionInput added in v1.40.52

type DescribeAlertManagerDefinitionInput struct {

	// The ID of the workspace to retrieve the alert manager definition from.
	//
	// 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 DescribeAlertManagerDefinition operation.

func (DescribeAlertManagerDefinitionInput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAlertManagerDefinitionInput) SetWorkspaceId added in v1.40.52

SetWorkspaceId sets the WorkspaceId field's value.

func (DescribeAlertManagerDefinitionInput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAlertManagerDefinitionInput) Validate added in v1.40.52

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

type DescribeAlertManagerDefinitionOutput added in v1.40.52

type DescribeAlertManagerDefinitionOutput struct {

	// The alert manager definition.
	//
	// AlertManagerDefinition is a required field
	AlertManagerDefinition *AlertManagerDefinitionDescription `locationName:"alertManagerDefinition" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeAlertManagerDefinition operation.

func (DescribeAlertManagerDefinitionOutput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAlertManagerDefinitionOutput) SetAlertManagerDefinition added in v1.40.52

SetAlertManagerDefinition sets the AlertManagerDefinition field's value.

func (DescribeAlertManagerDefinitionOutput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLoggingConfigurationInput added in v1.44.76

type DescribeLoggingConfigurationInput struct {

	// The ID of the workspace to describe the logging configuration for.
	//
	// 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 DescribeLoggingConfiguration operation.

func (DescribeLoggingConfigurationInput) GoString added in v1.44.76

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoggingConfigurationInput) SetWorkspaceId added in v1.44.76

SetWorkspaceId sets the WorkspaceId field's value.

func (DescribeLoggingConfigurationInput) String added in v1.44.76

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoggingConfigurationInput) Validate added in v1.44.76

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

type DescribeLoggingConfigurationOutput added in v1.44.76

type DescribeLoggingConfigurationOutput struct {

	// A structure that displays the information about the logging configuration.
	//
	// LoggingConfiguration is a required field
	LoggingConfiguration *LoggingConfigurationMetadata `locationName:"loggingConfiguration" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeLoggingConfiguration operation.

func (DescribeLoggingConfigurationOutput) GoString added in v1.44.76

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoggingConfigurationOutput) SetLoggingConfiguration added in v1.44.76

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (DescribeLoggingConfigurationOutput) String added in v1.44.76

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeRuleGroupsNamespaceInput added in v1.40.52

type DescribeRuleGroupsNamespaceInput struct {

	// The name of the rule groups namespace that you want information for.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`

	// The ID of the workspace containing the rule groups namespace.
	//
	// 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 DescribeRuleGroupsNamespace operation.

func (DescribeRuleGroupsNamespaceInput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleGroupsNamespaceInput) SetName added in v1.40.52

SetName sets the Name field's value.

func (*DescribeRuleGroupsNamespaceInput) SetWorkspaceId added in v1.40.52

SetWorkspaceId sets the WorkspaceId field's value.

func (DescribeRuleGroupsNamespaceInput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleGroupsNamespaceInput) Validate added in v1.40.52

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

type DescribeRuleGroupsNamespaceOutput added in v1.40.52

type DescribeRuleGroupsNamespaceOutput struct {

	// The information about the rule groups namespace.
	//
	// RuleGroupsNamespace is a required field
	RuleGroupsNamespace *RuleGroupsNamespaceDescription `locationName:"ruleGroupsNamespace" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeRuleGroupsNamespace operation.

func (DescribeRuleGroupsNamespaceOutput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleGroupsNamespaceOutput) SetRuleGroupsNamespace added in v1.40.52

SetRuleGroupsNamespace sets the RuleGroupsNamespace field's value.

func (DescribeRuleGroupsNamespaceOutput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeScraperInput added in v1.48.4

type DescribeScraperInput struct {

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

Represents the input of a DescribeScraper operation.

func (DescribeScraperInput) GoString added in v1.48.4

func (s DescribeScraperInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScraperInput) SetScraperId added in v1.48.4

func (s *DescribeScraperInput) SetScraperId(v string) *DescribeScraperInput

SetScraperId sets the ScraperId field's value.

func (DescribeScraperInput) String added in v1.48.4

func (s DescribeScraperInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScraperInput) Validate added in v1.48.4

func (s *DescribeScraperInput) Validate() error

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

type DescribeScraperOutput added in v1.48.4

type DescribeScraperOutput struct {

	// Contains details about the scraper.
	//
	// Scraper is a required field
	Scraper *ScraperDescription `locationName:"scraper" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeScraper operation.

func (DescribeScraperOutput) GoString added in v1.48.4

func (s DescribeScraperOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeScraperOutput) SetScraper added in v1.48.4

SetScraper sets the Scraper field's value.

func (DescribeScraperOutput) String added in v1.48.4

func (s DescribeScraperOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceInput) SetWorkspaceId

SetWorkspaceId sets the WorkspaceId field's value.

func (DescribeWorkspaceInput) String

func (s DescribeWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A structure that contains details about the 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceOutput) SetWorkspace

SetWorkspace sets the Workspace field's value.

func (DescribeWorkspaceOutput) String

func (s DescribeWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Destination added in v1.48.4

type Destination struct {

	// The Amazon Managed Service for Prometheusworkspace to send metrics to.
	AmpConfiguration *AmpConfiguration `locationName:"ampConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

Where to send the metrics from a scraper.

func (Destination) GoString added in v1.48.4

func (s Destination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Destination) SetAmpConfiguration added in v1.48.4

func (s *Destination) SetAmpConfiguration(v *AmpConfiguration) *Destination

SetAmpConfiguration sets the AmpConfiguration field's value.

func (Destination) String added in v1.48.4

func (s Destination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Destination) Validate added in v1.48.4

func (s *Destination) Validate() error

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

type EksConfiguration added in v1.48.4

type EksConfiguration struct {

	// ARN of the Amazon EKS cluster.
	//
	// ClusterArn is a required field
	ClusterArn *string `locationName:"clusterArn" type:"string" required:"true"`

	// A list of the security group IDs for the Amazon EKS cluster VPC configuration.
	SecurityGroupIds []*string `locationName:"securityGroupIds" min:"1" type:"list"`

	// A list of subnet IDs for the Amazon EKS cluster VPC configuration.
	//
	// SubnetIds is a required field
	SubnetIds []*string `locationName:"subnetIds" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

The EksConfiguration structure describes the connection to the Amazon EKS cluster from which a scraper collects metrics.

func (EksConfiguration) GoString added in v1.48.4

func (s EksConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EksConfiguration) SetClusterArn added in v1.48.4

func (s *EksConfiguration) SetClusterArn(v string) *EksConfiguration

SetClusterArn sets the ClusterArn field's value.

func (*EksConfiguration) SetSecurityGroupIds added in v1.48.4

func (s *EksConfiguration) SetSecurityGroupIds(v []*string) *EksConfiguration

SetSecurityGroupIds sets the SecurityGroupIds field's value.

func (*EksConfiguration) SetSubnetIds added in v1.48.4

func (s *EksConfiguration) SetSubnetIds(v []*string) *EksConfiguration

SetSubnetIds sets the SubnetIds field's value.

func (EksConfiguration) String added in v1.48.4

func (s EksConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EksConfiguration) Validate added in v1.48.4

func (s *EksConfiguration) Validate() error

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

type GetDefaultScraperConfigurationInput added in v1.48.4

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

Represents the input of a GetDefaultScraperConfiguration operation.

func (GetDefaultScraperConfigurationInput) GoString added in v1.48.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetDefaultScraperConfigurationInput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetDefaultScraperConfigurationOutput added in v1.48.4

type GetDefaultScraperConfigurationOutput struct {

	// The configuration file. Base 64 encoded. For more information, see Scraper
	// configuration (https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration)in
	// the Amazon Managed Service for Prometheus User Guide.
	// Configuration is automatically base64 encoded/decoded by the SDK.
	//
	// Configuration is a required field
	Configuration []byte `locationName:"configuration" type:"blob" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a GetDefaultScraperConfiguration operation.

func (GetDefaultScraperConfigurationOutput) GoString added in v1.48.4

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetDefaultScraperConfigurationOutput) SetConfiguration added in v1.48.4

SetConfiguration sets the Configuration field's value.

func (GetDefaultScraperConfigurationOutput) String added in v1.48.4

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

An unexpected error occurred during the processing of the 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRuleGroupsNamespacesInput added in v1.40.52

type ListRuleGroupsNamespacesInput struct {

	// The maximum number of results to return. The default is 100.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// Use this parameter to filter the rule groups namespaces that are returned.
	// Only the namespaces with names that begin with the value that you specify
	// are returned.
	Name *string `location:"querystring" locationName:"name" min:"1" type:"string"`

	// The token for the next set of items to return. You receive this token from
	// a previous call, and use it to get the next page of results. The other parameters
	// must be the same as the initial call.
	//
	// For example, if your initial request has maxResults of 10, and there are
	// 12 rule groups namespaces to return, then your initial request will return
	// 10 and a nextToken. Using the next token in a subsequent call will return
	// the remaining 2 namespaces.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The ID of the workspace containing the rule groups namespaces.
	//
	// 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 ListRuleGroupsNamespaces operation.

func (ListRuleGroupsNamespacesInput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRuleGroupsNamespacesInput) SetMaxResults added in v1.40.52

SetMaxResults sets the MaxResults field's value.

func (*ListRuleGroupsNamespacesInput) SetName added in v1.40.52

SetName sets the Name field's value.

func (*ListRuleGroupsNamespacesInput) SetNextToken added in v1.40.52

SetNextToken sets the NextToken field's value.

func (*ListRuleGroupsNamespacesInput) SetWorkspaceId added in v1.40.52

SetWorkspaceId sets the WorkspaceId field's value.

func (ListRuleGroupsNamespacesInput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRuleGroupsNamespacesInput) Validate added in v1.40.52

func (s *ListRuleGroupsNamespacesInput) Validate() error

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

type ListRuleGroupsNamespacesOutput added in v1.40.52

type ListRuleGroupsNamespacesOutput struct {

	// A token indicating that there are more results to retrieve. You can use this
	// token as part of your next ListRuleGroupsNamespaces request to retrieve those
	// results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The returned list of rule groups namespaces.
	//
	// RuleGroupsNamespaces is a required field
	RuleGroupsNamespaces []*RuleGroupsNamespaceSummary `locationName:"ruleGroupsNamespaces" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a ListRuleGroupsNamespaces operation.

func (ListRuleGroupsNamespacesOutput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRuleGroupsNamespacesOutput) SetNextToken added in v1.40.52

SetNextToken sets the NextToken field's value.

func (*ListRuleGroupsNamespacesOutput) SetRuleGroupsNamespaces added in v1.40.52

SetRuleGroupsNamespaces sets the RuleGroupsNamespaces field's value.

func (ListRuleGroupsNamespacesOutput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListScrapersInput added in v1.48.4

type ListScrapersInput struct {

	// (Optional) A list of key-value pairs to filter the list of scrapers returned.
	// Keys include status, sourceArn, destinationArn, and alias.
	//
	// Filters on the same key are OR'd together, and filters on different keys
	// are AND'd together. For example, status=ACTIVE&status=CREATING&alias=Test,
	// will return all scrapers that have the alias Test, and are either in status
	// ACTIVE or CREATING.
	//
	// To find all active scrapers that are sending metrics to a specific Amazon
	// Managed Service for Prometheus workspace, you would use the ARN of the workspace
	// in a query:
	//
	// status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012
	//
	// If this is included, it filters the results to only the scrapers that match
	// the filter.
	Filters map[string][]*string `location:"querystring" locationName:"filters" min:"1" type:"map"`

	// Optional) The maximum number of scrapers to return in one ListScrapers operation.
	// The range is 1-1000.
	//
	// If you omit this parameter, the default of 100 is used.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// (Optional) The token for the next set of items to return. (You received this
	// token from a previous call.)
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Represents the input of a ListScrapers operation.

func (ListScrapersInput) GoString added in v1.48.4

func (s ListScrapersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScrapersInput) SetFilters added in v1.48.4

func (s *ListScrapersInput) SetFilters(v map[string][]*string) *ListScrapersInput

SetFilters sets the Filters field's value.

func (*ListScrapersInput) SetMaxResults added in v1.48.4

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

SetMaxResults sets the MaxResults field's value.

func (*ListScrapersInput) SetNextToken added in v1.48.4

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

SetNextToken sets the NextToken field's value.

func (ListScrapersInput) String added in v1.48.4

func (s ListScrapersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScrapersInput) Validate added in v1.48.4

func (s *ListScrapersInput) Validate() error

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

type ListScrapersOutput added in v1.48.4

type ListScrapersOutput struct {

	// A token indicating that there are more results to retrieve. You can use this
	// token as part of your next ListScrapers operation to retrieve those results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of ScraperSummary structures giving information about scrapers in
	// the account that match the filters provided.
	//
	// Scrapers is a required field
	Scrapers []*ScraperSummary `locationName:"scrapers" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a ListScrapers operation.

func (ListScrapersOutput) GoString added in v1.48.4

func (s ListScrapersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListScrapersOutput) SetNextToken added in v1.48.4

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

SetNextToken sets the NextToken field's value.

func (*ListScrapersOutput) SetScrapers added in v1.48.4

SetScrapers sets the Scrapers field's value.

func (ListScrapersOutput) String added in v1.48.4

func (s ListScrapersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.40.38

type ListTagsForResourceInput struct {

	// The ARN of the resource to list tages for. Must be a workspace or rule groups
	// namespace resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.40.38

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.40.38

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.40.38

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.40.38

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v1.40.38

type ListTagsForResourceOutput struct {

	// The list of tag keys and values associated with the resource.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.40.38

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.40.38

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.40.38

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWorkspacesInput

type ListWorkspacesInput struct {

	// If this is included, it filters the results to only the workspaces with names
	// that start with the value that you specify here.
	//
	// Amazon Managed Service for Prometheus will automatically strip any blank
	// spaces from the beginning and end of the alias that you specify.
	Alias *string `location:"querystring" locationName:"alias" min:"1" type:"string"`

	// The maximum number of workspaces to return per request. The default is 100.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of items to return. You receive this token from
	// a previous call, and use it to get the next page of results. The other parameters
	// must be the same as the initial call.
	//
	// For example, if your initial request has maxResults of 10, and there are
	// 12 workspaces to return, then your initial request will return 10 and a nextToken.
	// Using the next token in a subsequent call will return the remaining 2 workspaces.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkspacesInput) SetAlias

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A token indicating that there are more results to retrieve. You can use this
	// token as part of your next ListWorkspaces request to retrieve those results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of WorkspaceSummary structures containing information about the
	// workspaces requested.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkspacesOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (*ListWorkspacesOutput) SetWorkspaces

SetWorkspaces sets the Workspaces field's value.

func (ListWorkspacesOutput) String

func (s ListWorkspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoggingConfigurationMetadata added in v1.44.76

type LoggingConfigurationMetadata struct {

	// The date and time that the logging configuration was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"`

	// The ARN of the CloudWatch log group to which the vended log data will be
	// published.
	//
	// LogGroupArn is a required field
	LogGroupArn *string `locationName:"logGroupArn" type:"string" required:"true"`

	// The date and time that the logging configuration was most recently changed.
	//
	// ModifiedAt is a required field
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp" required:"true"`

	// The current status of the logging configuration.
	//
	// Status is a required field
	Status *LoggingConfigurationStatus `locationName:"status" type:"structure" required:"true"`

	// The ID of the workspace the logging configuration is for.
	//
	// Workspace is a required field
	Workspace *string `locationName:"workspace" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information about the logging configuration.

func (LoggingConfigurationMetadata) GoString added in v1.44.76

func (s LoggingConfigurationMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingConfigurationMetadata) SetCreatedAt added in v1.44.76

SetCreatedAt sets the CreatedAt field's value.

func (*LoggingConfigurationMetadata) SetLogGroupArn added in v1.44.76

SetLogGroupArn sets the LogGroupArn field's value.

func (*LoggingConfigurationMetadata) SetModifiedAt added in v1.44.76

SetModifiedAt sets the ModifiedAt field's value.

func (*LoggingConfigurationMetadata) SetStatus added in v1.44.76

SetStatus sets the Status field's value.

func (*LoggingConfigurationMetadata) SetWorkspace added in v1.44.76

SetWorkspace sets the Workspace field's value.

func (LoggingConfigurationMetadata) String added in v1.44.76

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoggingConfigurationStatus added in v1.44.76

type LoggingConfigurationStatus struct {

	// The current status of the logging configuration.
	//
	// StatusCode is a required field
	StatusCode *string `locationName:"statusCode" type:"string" required:"true" enum:"LoggingConfigurationStatusCode"`

	// If failed, the reason for the failure.
	StatusReason *string `locationName:"statusReason" type:"string"`
	// contains filtered or unexported fields
}

The status of the logging configuration.

func (LoggingConfigurationStatus) GoString added in v1.44.76

func (s LoggingConfigurationStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingConfigurationStatus) SetStatusCode added in v1.44.76

SetStatusCode sets the StatusCode field's value.

func (*LoggingConfigurationStatus) SetStatusReason added in v1.44.76

SetStatusReason sets the StatusReason field's value.

func (LoggingConfigurationStatus) String added in v1.44.76

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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

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) CreateAlertManagerDefinition added in v1.40.52

CreateAlertManagerDefinition API operation for Amazon Prometheus Service.

The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.

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 CreateAlertManagerDefinition for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

  • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.

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

func (*PrometheusService) CreateAlertManagerDefinitionRequest added in v1.40.52

func (c *PrometheusService) CreateAlertManagerDefinitionRequest(input *CreateAlertManagerDefinitionInput) (req *request.Request, output *CreateAlertManagerDefinitionOutput)

CreateAlertManagerDefinitionRequest generates a "aws/request.Request" representing the client's request for the CreateAlertManagerDefinition 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 CreateAlertManagerDefinition for more information on using the CreateAlertManagerDefinition 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 CreateAlertManagerDefinitionRequest method.
req, resp := client.CreateAlertManagerDefinitionRequest(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/CreateAlertManagerDefinition

func (*PrometheusService) CreateAlertManagerDefinitionWithContext added in v1.40.52

func (c *PrometheusService) CreateAlertManagerDefinitionWithContext(ctx aws.Context, input *CreateAlertManagerDefinitionInput, opts ...request.Option) (*CreateAlertManagerDefinitionOutput, error)

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

See CreateAlertManagerDefinition 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) CreateLoggingConfiguration added in v1.44.76

CreateLoggingConfiguration API operation for Amazon Prometheus Service.

The CreateLoggingConfiguration operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.

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 CreateLoggingConfiguration for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) CreateLoggingConfigurationRequest added in v1.44.76

func (c *PrometheusService) CreateLoggingConfigurationRequest(input *CreateLoggingConfigurationInput) (req *request.Request, output *CreateLoggingConfigurationOutput)

CreateLoggingConfigurationRequest generates a "aws/request.Request" representing the client's request for the CreateLoggingConfiguration 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 CreateLoggingConfiguration for more information on using the CreateLoggingConfiguration 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 CreateLoggingConfigurationRequest method.
req, resp := client.CreateLoggingConfigurationRequest(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/CreateLoggingConfiguration

func (*PrometheusService) CreateLoggingConfigurationWithContext added in v1.44.76

func (c *PrometheusService) CreateLoggingConfigurationWithContext(ctx aws.Context, input *CreateLoggingConfigurationInput, opts ...request.Option) (*CreateLoggingConfigurationOutput, error)

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

See CreateLoggingConfiguration 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) CreateRuleGroupsNamespace added in v1.40.52

CreateRuleGroupsNamespace API operation for Amazon Prometheus Service.

The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.

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 CreateRuleGroupsNamespace for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

  • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.

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

func (*PrometheusService) CreateRuleGroupsNamespaceRequest added in v1.40.52

func (c *PrometheusService) CreateRuleGroupsNamespaceRequest(input *CreateRuleGroupsNamespaceInput) (req *request.Request, output *CreateRuleGroupsNamespaceOutput)

CreateRuleGroupsNamespaceRequest generates a "aws/request.Request" representing the client's request for the CreateRuleGroupsNamespace 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 CreateRuleGroupsNamespace for more information on using the CreateRuleGroupsNamespace 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 CreateRuleGroupsNamespaceRequest method.
req, resp := client.CreateRuleGroupsNamespaceRequest(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/CreateRuleGroupsNamespace

func (*PrometheusService) CreateRuleGroupsNamespaceWithContext added in v1.40.52

func (c *PrometheusService) CreateRuleGroupsNamespaceWithContext(ctx aws.Context, input *CreateRuleGroupsNamespaceInput, opts ...request.Option) (*CreateRuleGroupsNamespaceOutput, error)

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

See CreateRuleGroupsNamespace 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) CreateScraper added in v1.48.4

func (c *PrometheusService) CreateScraper(input *CreateScraperInput) (*CreateScraperOutput, error)

CreateScraper API operation for Amazon Prometheus Service.

The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the scraper to control what metrics are collected, and what transformations are applied prior to sending them to your workspace.

If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see Using roles for scraping metrics from EKS (https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper) in the Amazon Managed Service for Prometheus User Guide.

You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one.

The scrapeConfiguration parameter contains the base64-encoded version of the YAML configuration file.

For more information about collectors, including what metrics are collected, and how to configure the scraper, see Amazon Web Services managed collectors (https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html) in the Amazon Managed Service for Prometheus User Guide.

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 CreateScraper for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

  • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.

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

func (*PrometheusService) CreateScraperRequest added in v1.48.4

func (c *PrometheusService) CreateScraperRequest(input *CreateScraperInput) (req *request.Request, output *CreateScraperOutput)

CreateScraperRequest generates a "aws/request.Request" representing the client's request for the CreateScraper 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 CreateScraper for more information on using the CreateScraper 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 CreateScraperRequest method.
req, resp := client.CreateScraperRequest(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/CreateScraper

func (*PrometheusService) CreateScraperWithContext added in v1.48.4

func (c *PrometheusService) CreateScraperWithContext(ctx aws.Context, input *CreateScraperInput, opts ...request.Option) (*CreateScraperOutput, error)

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

See CreateScraper 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) CreateWorkspace

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

CreateWorkspace API operation for Amazon Prometheus Service.

Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.

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 The request was denied due to request throttling.

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

  • ServiceQuotaExceededException Completing the 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) DeleteAlertManagerDefinition added in v1.40.52

DeleteAlertManagerDefinition API operation for Amazon Prometheus Service.

Deletes the alert manager definition from a 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 DeleteAlertManagerDefinition for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) DeleteAlertManagerDefinitionRequest added in v1.40.52

func (c *PrometheusService) DeleteAlertManagerDefinitionRequest(input *DeleteAlertManagerDefinitionInput) (req *request.Request, output *DeleteAlertManagerDefinitionOutput)

DeleteAlertManagerDefinitionRequest generates a "aws/request.Request" representing the client's request for the DeleteAlertManagerDefinition 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 DeleteAlertManagerDefinition for more information on using the DeleteAlertManagerDefinition 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 DeleteAlertManagerDefinitionRequest method.
req, resp := client.DeleteAlertManagerDefinitionRequest(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/DeleteAlertManagerDefinition

func (*PrometheusService) DeleteAlertManagerDefinitionWithContext added in v1.40.52

func (c *PrometheusService) DeleteAlertManagerDefinitionWithContext(ctx aws.Context, input *DeleteAlertManagerDefinitionInput, opts ...request.Option) (*DeleteAlertManagerDefinitionOutput, error)

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

See DeleteAlertManagerDefinition 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) DeleteLoggingConfiguration added in v1.44.76

DeleteLoggingConfiguration API operation for Amazon Prometheus Service.

Deletes the logging configuration for a 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 DeleteLoggingConfiguration for usage and error information.

Returned Error Types:

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) DeleteLoggingConfigurationRequest added in v1.44.76

func (c *PrometheusService) DeleteLoggingConfigurationRequest(input *DeleteLoggingConfigurationInput) (req *request.Request, output *DeleteLoggingConfigurationOutput)

DeleteLoggingConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteLoggingConfiguration 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 DeleteLoggingConfiguration for more information on using the DeleteLoggingConfiguration 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 DeleteLoggingConfigurationRequest method.
req, resp := client.DeleteLoggingConfigurationRequest(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/DeleteLoggingConfiguration

func (*PrometheusService) DeleteLoggingConfigurationWithContext added in v1.44.76

func (c *PrometheusService) DeleteLoggingConfigurationWithContext(ctx aws.Context, input *DeleteLoggingConfigurationInput, opts ...request.Option) (*DeleteLoggingConfigurationOutput, error)

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

See DeleteLoggingConfiguration 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) DeleteRuleGroupsNamespace added in v1.40.52

DeleteRuleGroupsNamespace API operation for Amazon Prometheus Service.

Deletes one rule groups namespace and its associated rule groups definition.

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 DeleteRuleGroupsNamespace for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) DeleteRuleGroupsNamespaceRequest added in v1.40.52

func (c *PrometheusService) DeleteRuleGroupsNamespaceRequest(input *DeleteRuleGroupsNamespaceInput) (req *request.Request, output *DeleteRuleGroupsNamespaceOutput)

DeleteRuleGroupsNamespaceRequest generates a "aws/request.Request" representing the client's request for the DeleteRuleGroupsNamespace 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 DeleteRuleGroupsNamespace for more information on using the DeleteRuleGroupsNamespace 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 DeleteRuleGroupsNamespaceRequest method.
req, resp := client.DeleteRuleGroupsNamespaceRequest(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/DeleteRuleGroupsNamespace

func (*PrometheusService) DeleteRuleGroupsNamespaceWithContext added in v1.40.52

func (c *PrometheusService) DeleteRuleGroupsNamespaceWithContext(ctx aws.Context, input *DeleteRuleGroupsNamespaceInput, opts ...request.Option) (*DeleteRuleGroupsNamespaceOutput, error)

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

See DeleteRuleGroupsNamespace 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) DeleteScraper added in v1.48.4

func (c *PrometheusService) DeleteScraper(input *DeleteScraperInput) (*DeleteScraperOutput, error)

DeleteScraper API operation for Amazon Prometheus Service.

The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.

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 DeleteScraper for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) DeleteScraperRequest added in v1.48.4

func (c *PrometheusService) DeleteScraperRequest(input *DeleteScraperInput) (req *request.Request, output *DeleteScraperOutput)

DeleteScraperRequest generates a "aws/request.Request" representing the client's request for the DeleteScraper 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 DeleteScraper for more information on using the DeleteScraper 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 DeleteScraperRequest method.
req, resp := client.DeleteScraperRequest(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/DeleteScraper

func (*PrometheusService) DeleteScraperWithContext added in v1.48.4

func (c *PrometheusService) DeleteScraperWithContext(ctx aws.Context, input *DeleteScraperInput, opts ...request.Option) (*DeleteScraperOutput, error)

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

See DeleteScraper 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 existing workspace.

When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.

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 The request was denied due to request throttling.

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the 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) DescribeAlertManagerDefinition added in v1.40.52

DescribeAlertManagerDefinition API operation for Amazon Prometheus Service.

Retrieves the full information about the alert manager definition for a 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 DescribeAlertManagerDefinition for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) DescribeAlertManagerDefinitionRequest added in v1.40.52

func (c *PrometheusService) DescribeAlertManagerDefinitionRequest(input *DescribeAlertManagerDefinitionInput) (req *request.Request, output *DescribeAlertManagerDefinitionOutput)

DescribeAlertManagerDefinitionRequest generates a "aws/request.Request" representing the client's request for the DescribeAlertManagerDefinition 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 DescribeAlertManagerDefinition for more information on using the DescribeAlertManagerDefinition 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 DescribeAlertManagerDefinitionRequest method.
req, resp := client.DescribeAlertManagerDefinitionRequest(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/DescribeAlertManagerDefinition

func (*PrometheusService) DescribeAlertManagerDefinitionWithContext added in v1.40.52

func (c *PrometheusService) DescribeAlertManagerDefinitionWithContext(ctx aws.Context, input *DescribeAlertManagerDefinitionInput, opts ...request.Option) (*DescribeAlertManagerDefinitionOutput, error)

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

See DescribeAlertManagerDefinition 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) DescribeLoggingConfiguration added in v1.44.76

DescribeLoggingConfiguration API operation for Amazon Prometheus Service.

Returns complete information about the current logging configuration of the 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 DescribeLoggingConfiguration for usage and error information.

Returned Error Types:

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) DescribeLoggingConfigurationRequest added in v1.44.76

func (c *PrometheusService) DescribeLoggingConfigurationRequest(input *DescribeLoggingConfigurationInput) (req *request.Request, output *DescribeLoggingConfigurationOutput)

DescribeLoggingConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeLoggingConfiguration 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 DescribeLoggingConfiguration for more information on using the DescribeLoggingConfiguration 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 DescribeLoggingConfigurationRequest method.
req, resp := client.DescribeLoggingConfigurationRequest(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/DescribeLoggingConfiguration

func (*PrometheusService) DescribeLoggingConfigurationWithContext added in v1.44.76

func (c *PrometheusService) DescribeLoggingConfigurationWithContext(ctx aws.Context, input *DescribeLoggingConfigurationInput, opts ...request.Option) (*DescribeLoggingConfigurationOutput, error)

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

See DescribeLoggingConfiguration 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) DescribeRuleGroupsNamespace added in v1.40.52

DescribeRuleGroupsNamespace API operation for Amazon Prometheus Service.

Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.

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 DescribeRuleGroupsNamespace for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) DescribeRuleGroupsNamespaceRequest added in v1.40.52

func (c *PrometheusService) DescribeRuleGroupsNamespaceRequest(input *DescribeRuleGroupsNamespaceInput) (req *request.Request, output *DescribeRuleGroupsNamespaceOutput)

DescribeRuleGroupsNamespaceRequest generates a "aws/request.Request" representing the client's request for the DescribeRuleGroupsNamespace 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 DescribeRuleGroupsNamespace for more information on using the DescribeRuleGroupsNamespace 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 DescribeRuleGroupsNamespaceRequest method.
req, resp := client.DescribeRuleGroupsNamespaceRequest(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/DescribeRuleGroupsNamespace

func (*PrometheusService) DescribeRuleGroupsNamespaceWithContext added in v1.40.52

func (c *PrometheusService) DescribeRuleGroupsNamespaceWithContext(ctx aws.Context, input *DescribeRuleGroupsNamespaceInput, opts ...request.Option) (*DescribeRuleGroupsNamespaceOutput, error)

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

See DescribeRuleGroupsNamespace 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) DescribeScraper added in v1.48.4

func (c *PrometheusService) DescribeScraper(input *DescribeScraperInput) (*DescribeScraperOutput, error)

DescribeScraper API operation for Amazon Prometheus Service.

The DescribeScraper operation displays information about an existing scraper.

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 DescribeScraper for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) DescribeScraperRequest added in v1.48.4

func (c *PrometheusService) DescribeScraperRequest(input *DescribeScraperInput) (req *request.Request, output *DescribeScraperOutput)

DescribeScraperRequest generates a "aws/request.Request" representing the client's request for the DescribeScraper 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 DescribeScraper for more information on using the DescribeScraper 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 DescribeScraperRequest method.
req, resp := client.DescribeScraperRequest(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/DescribeScraper

func (*PrometheusService) DescribeScraperWithContext added in v1.48.4

func (c *PrometheusService) DescribeScraperWithContext(ctx aws.Context, input *DescribeScraperInput, opts ...request.Option) (*DescribeScraperOutput, error)

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

See DescribeScraper 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.

Returns information about an existing 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 The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the 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) GetDefaultScraperConfiguration added in v1.48.4

GetDefaultScraperConfiguration API operation for Amazon Prometheus Service.

The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.

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 GetDefaultScraperConfiguration for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) GetDefaultScraperConfigurationRequest added in v1.48.4

func (c *PrometheusService) GetDefaultScraperConfigurationRequest(input *GetDefaultScraperConfigurationInput) (req *request.Request, output *GetDefaultScraperConfigurationOutput)

GetDefaultScraperConfigurationRequest generates a "aws/request.Request" representing the client's request for the GetDefaultScraperConfiguration 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 GetDefaultScraperConfiguration for more information on using the GetDefaultScraperConfiguration 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 GetDefaultScraperConfigurationRequest method.
req, resp := client.GetDefaultScraperConfigurationRequest(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/GetDefaultScraperConfiguration

func (*PrometheusService) GetDefaultScraperConfigurationWithContext added in v1.48.4

func (c *PrometheusService) GetDefaultScraperConfigurationWithContext(ctx aws.Context, input *GetDefaultScraperConfigurationInput, opts ...request.Option) (*GetDefaultScraperConfigurationOutput, error)

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

See GetDefaultScraperConfiguration 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) ListRuleGroupsNamespaces added in v1.40.52

ListRuleGroupsNamespaces API operation for Amazon Prometheus Service.

Returns a list of rule groups namespaces in a 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 ListRuleGroupsNamespaces for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) ListRuleGroupsNamespacesPages added in v1.40.52

func (c *PrometheusService) ListRuleGroupsNamespacesPages(input *ListRuleGroupsNamespacesInput, fn func(*ListRuleGroupsNamespacesOutput, bool) bool) error

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

See ListRuleGroupsNamespaces 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 ListRuleGroupsNamespaces operation.
pageNum := 0
err := client.ListRuleGroupsNamespacesPages(params,
    func(page *prometheusservice.ListRuleGroupsNamespacesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PrometheusService) ListRuleGroupsNamespacesPagesWithContext added in v1.40.52

func (c *PrometheusService) ListRuleGroupsNamespacesPagesWithContext(ctx aws.Context, input *ListRuleGroupsNamespacesInput, fn func(*ListRuleGroupsNamespacesOutput, bool) bool, opts ...request.Option) error

ListRuleGroupsNamespacesPagesWithContext same as ListRuleGroupsNamespacesPages 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) ListRuleGroupsNamespacesRequest added in v1.40.52

func (c *PrometheusService) ListRuleGroupsNamespacesRequest(input *ListRuleGroupsNamespacesInput) (req *request.Request, output *ListRuleGroupsNamespacesOutput)

ListRuleGroupsNamespacesRequest generates a "aws/request.Request" representing the client's request for the ListRuleGroupsNamespaces 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 ListRuleGroupsNamespaces for more information on using the ListRuleGroupsNamespaces 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 ListRuleGroupsNamespacesRequest method.
req, resp := client.ListRuleGroupsNamespacesRequest(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/ListRuleGroupsNamespaces

func (*PrometheusService) ListRuleGroupsNamespacesWithContext added in v1.40.52

func (c *PrometheusService) ListRuleGroupsNamespacesWithContext(ctx aws.Context, input *ListRuleGroupsNamespacesInput, opts ...request.Option) (*ListRuleGroupsNamespacesOutput, error)

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

See ListRuleGroupsNamespaces 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) ListScrapers added in v1.48.4

func (c *PrometheusService) ListScrapers(input *ListScrapersInput) (*ListScrapersOutput, error)

ListScrapers API operation for Amazon Prometheus Service.

The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.

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 ListScrapers for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) ListScrapersPages added in v1.48.4

func (c *PrometheusService) ListScrapersPages(input *ListScrapersInput, fn func(*ListScrapersOutput, bool) bool) error

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

See ListScrapers 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 ListScrapers operation.
pageNum := 0
err := client.ListScrapersPages(params,
    func(page *prometheusservice.ListScrapersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*PrometheusService) ListScrapersPagesWithContext added in v1.48.4

func (c *PrometheusService) ListScrapersPagesWithContext(ctx aws.Context, input *ListScrapersInput, fn func(*ListScrapersOutput, bool) bool, opts ...request.Option) error

ListScrapersPagesWithContext same as ListScrapersPages 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) ListScrapersRequest added in v1.48.4

func (c *PrometheusService) ListScrapersRequest(input *ListScrapersInput) (req *request.Request, output *ListScrapersOutput)

ListScrapersRequest generates a "aws/request.Request" representing the client's request for the ListScrapers 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 ListScrapers for more information on using the ListScrapers 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 ListScrapersRequest method.
req, resp := client.ListScrapersRequest(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/ListScrapers

func (*PrometheusService) ListScrapersWithContext added in v1.48.4

func (c *PrometheusService) ListScrapersWithContext(ctx aws.Context, input *ListScrapersInput, opts ...request.Option) (*ListScrapersOutput, error)

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

See ListScrapers 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) ListTagsForResource added in v1.40.38

ListTagsForResource API operation for Amazon Prometheus Service.

The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are workspaces and rule groups namespaces.

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 ListTagsForResource for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) ListTagsForResourceRequest added in v1.40.38

func (c *PrometheusService) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource 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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(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/ListTagsForResource

func (*PrometheusService) ListTagsForResourceWithContext added in v1.40.38

func (c *PrometheusService) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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 of the Amazon Managed Service for Prometheus workspaces in your account. This includes 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 The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the 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) PutAlertManagerDefinition added in v1.40.52

PutAlertManagerDefinition API operation for Amazon Prometheus Service.

Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition.

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 PutAlertManagerDefinition for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

  • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.

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

func (*PrometheusService) PutAlertManagerDefinitionRequest added in v1.40.52

func (c *PrometheusService) PutAlertManagerDefinitionRequest(input *PutAlertManagerDefinitionInput) (req *request.Request, output *PutAlertManagerDefinitionOutput)

PutAlertManagerDefinitionRequest generates a "aws/request.Request" representing the client's request for the PutAlertManagerDefinition 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 PutAlertManagerDefinition for more information on using the PutAlertManagerDefinition 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 PutAlertManagerDefinitionRequest method.
req, resp := client.PutAlertManagerDefinitionRequest(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/PutAlertManagerDefinition

func (*PrometheusService) PutAlertManagerDefinitionWithContext added in v1.40.52

func (c *PrometheusService) PutAlertManagerDefinitionWithContext(ctx aws.Context, input *PutAlertManagerDefinitionInput, opts ...request.Option) (*PutAlertManagerDefinitionOutput, error)

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

See PutAlertManagerDefinition 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) PutRuleGroupsNamespace added in v1.40.52

PutRuleGroupsNamespace API operation for Amazon Prometheus Service.

Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace.

You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.

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 PutRuleGroupsNamespace for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

  • ServiceQuotaExceededException Completing the request would cause a service quota to be exceeded.

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

func (*PrometheusService) PutRuleGroupsNamespaceRequest added in v1.40.52

func (c *PrometheusService) PutRuleGroupsNamespaceRequest(input *PutRuleGroupsNamespaceInput) (req *request.Request, output *PutRuleGroupsNamespaceOutput)

PutRuleGroupsNamespaceRequest generates a "aws/request.Request" representing the client's request for the PutRuleGroupsNamespace 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 PutRuleGroupsNamespace for more information on using the PutRuleGroupsNamespace 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 PutRuleGroupsNamespaceRequest method.
req, resp := client.PutRuleGroupsNamespaceRequest(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/PutRuleGroupsNamespace

func (*PrometheusService) PutRuleGroupsNamespaceWithContext added in v1.40.52

func (c *PrometheusService) PutRuleGroupsNamespaceWithContext(ctx aws.Context, input *PutRuleGroupsNamespaceInput, opts ...request.Option) (*PutRuleGroupsNamespaceOutput, error)

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

See PutRuleGroupsNamespace 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) TagResource added in v1.40.38

func (c *PrometheusService) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Prometheus Service.

The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.

If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

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 TagResource for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) TagResourceRequest added in v1.40.38

func (c *PrometheusService) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource 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 TagResource for more information on using the TagResource 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 TagResourceRequest method.
req, resp := client.TagResourceRequest(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/TagResource

func (*PrometheusService) TagResourceWithContext added in v1.40.38

func (c *PrometheusService) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

See TagResource 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) UntagResource added in v1.40.38

func (c *PrometheusService) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Prometheus Service.

Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.

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 UntagResource for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) UntagResourceRequest added in v1.40.38

func (c *PrometheusService) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource 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 UntagResource for more information on using the UntagResource 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 UntagResourceRequest method.
req, resp := client.UntagResourceRequest(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/UntagResource

func (*PrometheusService) UntagResourceWithContext added in v1.40.38

func (c *PrometheusService) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

See UntagResource 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) UpdateLoggingConfiguration added in v1.44.76

UpdateLoggingConfiguration API operation for Amazon Prometheus Service.

Updates the log group ARN or the workspace ID of the current logging configuration.

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 UpdateLoggingConfiguration for usage and error information.

Returned Error Types:

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

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

func (*PrometheusService) UpdateLoggingConfigurationRequest added in v1.44.76

func (c *PrometheusService) UpdateLoggingConfigurationRequest(input *UpdateLoggingConfigurationInput) (req *request.Request, output *UpdateLoggingConfigurationOutput)

UpdateLoggingConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateLoggingConfiguration 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 UpdateLoggingConfiguration for more information on using the UpdateLoggingConfiguration 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 UpdateLoggingConfigurationRequest method.
req, resp := client.UpdateLoggingConfigurationRequest(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/UpdateLoggingConfiguration

func (*PrometheusService) UpdateLoggingConfigurationWithContext added in v1.44.76

func (c *PrometheusService) UpdateLoggingConfigurationWithContext(ctx aws.Context, input *UpdateLoggingConfigurationInput, opts ...request.Option) (*UpdateLoggingConfigurationOutput, error)

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

See UpdateLoggingConfiguration 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

UpdateWorkspaceAlias API operation for Amazon Prometheus Service.

Updates the alias of an existing 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 UpdateWorkspaceAlias for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • ConflictException The request would cause an inconsistent state.

  • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.

  • ResourceNotFoundException The request references a resources that doesn't exist.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • InternalServerException An unexpected error occurred during the processing of the request.

  • ServiceQuotaExceededException Completing the 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.

func (*PrometheusService) WaitUntilScraperActive added in v1.48.4

func (c *PrometheusService) WaitUntilScraperActive(input *DescribeScraperInput) error

WaitUntilScraperActive uses the Amazon Prometheus Service API operation DescribeScraper to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*PrometheusService) WaitUntilScraperActiveWithContext added in v1.48.4

func (c *PrometheusService) WaitUntilScraperActiveWithContext(ctx aws.Context, input *DescribeScraperInput, opts ...request.WaiterOption) error

WaitUntilScraperActiveWithContext is an extended version of WaitUntilScraperActive. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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) WaitUntilScraperDeleted added in v1.48.4

func (c *PrometheusService) WaitUntilScraperDeleted(input *DescribeScraperInput) error

WaitUntilScraperDeleted uses the Amazon Prometheus Service API operation DescribeScraper to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*PrometheusService) WaitUntilScraperDeletedWithContext added in v1.48.4

func (c *PrometheusService) WaitUntilScraperDeletedWithContext(ctx aws.Context, input *DescribeScraperInput, opts ...request.WaiterOption) error

WaitUntilScraperDeletedWithContext is an extended version of WaitUntilScraperDeleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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) WaitUntilWorkspaceActive added in v1.40.52

func (c *PrometheusService) WaitUntilWorkspaceActive(input *DescribeWorkspaceInput) error

WaitUntilWorkspaceActive uses the Amazon Prometheus Service API operation DescribeWorkspace to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*PrometheusService) WaitUntilWorkspaceActiveWithContext added in v1.40.52

func (c *PrometheusService) WaitUntilWorkspaceActiveWithContext(ctx aws.Context, input *DescribeWorkspaceInput, opts ...request.WaiterOption) error

WaitUntilWorkspaceActiveWithContext is an extended version of WaitUntilWorkspaceActive. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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) WaitUntilWorkspaceDeleted added in v1.40.52

func (c *PrometheusService) WaitUntilWorkspaceDeleted(input *DescribeWorkspaceInput) error

WaitUntilWorkspaceDeleted uses the Amazon Prometheus Service API operation DescribeWorkspace to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*PrometheusService) WaitUntilWorkspaceDeletedWithContext added in v1.40.52

func (c *PrometheusService) WaitUntilWorkspaceDeletedWithContext(ctx aws.Context, input *DescribeWorkspaceInput, opts ...request.WaiterOption) error

WaitUntilWorkspaceDeletedWithContext is an extended version of WaitUntilWorkspaceDeleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 PutAlertManagerDefinitionInput added in v1.40.52

type PutAlertManagerDefinitionInput struct {

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The alert manager definition to use. A base64-encoded version of the YAML
	// alert manager definition file.
	//
	// For details about the alert manager definition, see AlertManagedDefinitionData
	// (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html).
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `locationName:"data" type:"blob" required:"true"`

	// The ID of the workspace to update the alert manager definition in.
	//
	// 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 PutAlertManagerDefinition operation.

func (PutAlertManagerDefinitionInput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAlertManagerDefinitionInput) SetClientToken added in v1.40.52

SetClientToken sets the ClientToken field's value.

func (*PutAlertManagerDefinitionInput) SetData added in v1.40.52

SetData sets the Data field's value.

func (*PutAlertManagerDefinitionInput) SetWorkspaceId added in v1.40.52

SetWorkspaceId sets the WorkspaceId field's value.

func (PutAlertManagerDefinitionInput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAlertManagerDefinitionInput) Validate added in v1.40.52

func (s *PutAlertManagerDefinitionInput) Validate() error

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

type PutAlertManagerDefinitionOutput added in v1.40.52

type PutAlertManagerDefinitionOutput struct {

	// A structure that returns the current status of the alert manager definition.
	//
	// Status is a required field
	Status *AlertManagerDefinitionStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a PutAlertManagerDefinition operation.

func (PutAlertManagerDefinitionOutput) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAlertManagerDefinitionOutput) SetStatus added in v1.40.52

SetStatus sets the Status field's value.

func (PutAlertManagerDefinitionOutput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutRuleGroupsNamespaceInput added in v1.40.52

type PutRuleGroupsNamespaceInput struct {

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The new rules file to use in the namespace. A base64-encoded version of the
	// YAML rule groups file.
	//
	// For details about the rule groups namespace structure, see RuleGroupsNamespaceData
	// (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html).
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `locationName:"data" type:"blob" required:"true"`

	// The name of the rule groups namespace that you are updating.
	//
	// Name is a required field
	Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"`

	// The ID of the workspace where you are updating the rule groups namespace.
	//
	// 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 PutRuleGroupsNamespace operation.

func (PutRuleGroupsNamespaceInput) GoString added in v1.40.52

func (s PutRuleGroupsNamespaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRuleGroupsNamespaceInput) SetClientToken added in v1.40.52

SetClientToken sets the ClientToken field's value.

func (*PutRuleGroupsNamespaceInput) SetData added in v1.40.52

SetData sets the Data field's value.

func (*PutRuleGroupsNamespaceInput) SetName added in v1.40.52

SetName sets the Name field's value.

func (*PutRuleGroupsNamespaceInput) SetWorkspaceId added in v1.40.52

SetWorkspaceId sets the WorkspaceId field's value.

func (PutRuleGroupsNamespaceInput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRuleGroupsNamespaceInput) Validate added in v1.40.52

func (s *PutRuleGroupsNamespaceInput) Validate() error

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

type PutRuleGroupsNamespaceOutput added in v1.40.52

type PutRuleGroupsNamespaceOutput struct {

	// The ARN of the rule groups namespace.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The name of the rule groups namespace that was updated.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// A structure that includes the current status of the rule groups namespace.
	//
	// Status is a required field
	Status *RuleGroupsNamespaceStatus `locationName:"status" type:"structure" required:"true"`

	// The list of tag keys and values that are associated with the namespace.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Represents the output of a PutRuleGroupsNamespace operation.

func (PutRuleGroupsNamespaceOutput) GoString added in v1.40.52

func (s PutRuleGroupsNamespaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutRuleGroupsNamespaceOutput) SetArn added in v1.40.52

SetArn sets the Arn field's value.

func (*PutRuleGroupsNamespaceOutput) SetName added in v1.40.52

SetName sets the Name field's value.

func (*PutRuleGroupsNamespaceOutput) SetStatus added in v1.40.52

SetStatus sets the Status field's value.

func (*PutRuleGroupsNamespaceOutput) SetTags added in v1.40.52

SetTags sets the Tags field's value.

func (PutRuleGroupsNamespaceOutput) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

The request references a resources that doesn't exist.

func (*ResourceNotFoundException) Code

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupsNamespaceDescription added in v1.40.52

type RuleGroupsNamespaceDescription struct {

	// The ARN of the rule groups namespace.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The date and time that the rule groups namespace was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"`

	// The rule groups file used in the namespace.
	//
	// For details about the rule groups namespace structure, see RuleGroupsNamespaceData
	// (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html).
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `locationName:"data" type:"blob" required:"true"`

	// The date and time that the rule groups namespace was most recently changed.
	//
	// ModifiedAt is a required field
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp" required:"true"`

	// The name of the rule groups namespace.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The current status of the rule groups namespace.
	//
	// Status is a required field
	Status *RuleGroupsNamespaceStatus `locationName:"status" type:"structure" required:"true"`

	// The list of tag keys and values that are associated with the rule groups
	// namespace.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

The details about one rule groups namespace.

func (RuleGroupsNamespaceDescription) GoString added in v1.40.52

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupsNamespaceDescription) SetArn added in v1.40.52

SetArn sets the Arn field's value.

func (*RuleGroupsNamespaceDescription) SetCreatedAt added in v1.40.52

SetCreatedAt sets the CreatedAt field's value.

func (*RuleGroupsNamespaceDescription) SetData added in v1.40.52

SetData sets the Data field's value.

func (*RuleGroupsNamespaceDescription) SetModifiedAt added in v1.40.52

SetModifiedAt sets the ModifiedAt field's value.

func (*RuleGroupsNamespaceDescription) SetName added in v1.40.52

SetName sets the Name field's value.

func (*RuleGroupsNamespaceDescription) SetStatus added in v1.40.52

SetStatus sets the Status field's value.

func (*RuleGroupsNamespaceDescription) SetTags added in v1.40.52

SetTags sets the Tags field's value.

func (RuleGroupsNamespaceDescription) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupsNamespaceStatus added in v1.40.52

type RuleGroupsNamespaceStatus struct {

	// The current status of the namespace.
	//
	// StatusCode is a required field
	StatusCode *string `locationName:"statusCode" type:"string" required:"true" enum:"RuleGroupsNamespaceStatusCode"`

	// The reason for the failure, if any.
	StatusReason *string `locationName:"statusReason" type:"string"`
	// contains filtered or unexported fields
}

The status information about a rule groups namespace.

func (RuleGroupsNamespaceStatus) GoString added in v1.40.52

func (s RuleGroupsNamespaceStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupsNamespaceStatus) SetStatusCode added in v1.40.52

SetStatusCode sets the StatusCode field's value.

func (*RuleGroupsNamespaceStatus) SetStatusReason added in v1.40.52

SetStatusReason sets the StatusReason field's value.

func (RuleGroupsNamespaceStatus) String added in v1.40.52

func (s RuleGroupsNamespaceStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupsNamespaceSummary added in v1.40.52

type RuleGroupsNamespaceSummary struct {

	// The ARN of the rule groups namespace.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" type:"string" required:"true"`

	// The date and time that the rule groups namespace was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"`

	// The date and time that the rule groups namespace was most recently changed.
	//
	// ModifiedAt is a required field
	ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp" required:"true"`

	// The name of the rule groups namespace.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// A structure that displays the current status of the rule groups namespace.
	//
	// Status is a required field
	Status *RuleGroupsNamespaceStatus `locationName:"status" type:"structure" required:"true"`

	// The list of tag keys and values that are associated with the rule groups
	// namespace.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

The high-level information about a rule groups namespace. To retrieve more information, use DescribeRuleGroupsNamespace.

func (RuleGroupsNamespaceSummary) GoString added in v1.40.52

func (s RuleGroupsNamespaceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupsNamespaceSummary) SetArn added in v1.40.52

SetArn sets the Arn field's value.

func (*RuleGroupsNamespaceSummary) SetCreatedAt added in v1.40.52

SetCreatedAt sets the CreatedAt field's value.

func (*RuleGroupsNamespaceSummary) SetModifiedAt added in v1.40.52

SetModifiedAt sets the ModifiedAt field's value.

func (*RuleGroupsNamespaceSummary) SetName added in v1.40.52

SetName sets the Name field's value.

func (*RuleGroupsNamespaceSummary) SetStatus added in v1.40.52

SetStatus sets the Status field's value.

func (*RuleGroupsNamespaceSummary) SetTags added in v1.40.52

SetTags sets the Tags field's value.

func (RuleGroupsNamespaceSummary) String added in v1.40.52

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScrapeConfiguration added in v1.48.4

type ScrapeConfiguration struct {

	// The base 64 encoded scrape configuration file.
	// ConfigurationBlob is automatically base64 encoded/decoded by the SDK.
	ConfigurationBlob []byte `locationName:"configurationBlob" type:"blob"`
	// contains filtered or unexported fields
}

A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configuration (prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration) in the Amazon Managed Service for Prometheus User Guide.

func (ScrapeConfiguration) GoString added in v1.48.4

func (s ScrapeConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScrapeConfiguration) SetConfigurationBlob added in v1.48.4

func (s *ScrapeConfiguration) SetConfigurationBlob(v []byte) *ScrapeConfiguration

SetConfigurationBlob sets the ConfigurationBlob field's value.

func (ScrapeConfiguration) String added in v1.48.4

func (s ScrapeConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScraperDescription added in v1.48.4

type ScraperDescription struct {

	// (Optional) A name associated with the scraper.
	Alias *string `locationName:"alias" min:"1" type:"string"`

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

	// The date and time that the scraper was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"`

	// The Amazon Managed Service for Prometheus workspace the scraper sends metrics
	// to.
	//
	// Destination is a required field
	Destination *Destination `locationName:"destination" type:"structure" required:"true"`

	// The date and time that the scraper was last modified.
	//
	// LastModifiedAt is a required field
	LastModifiedAt *time.Time `locationName:"lastModifiedAt" type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that provides permissions
	// for the scraper to discover and collect metrics on your behalf.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The configuration file in use by the scraper.
	//
	// ScrapeConfiguration is a required field
	ScrapeConfiguration *ScrapeConfiguration `locationName:"scrapeConfiguration" type:"structure" required:"true"`

	// The ID of the scraper.
	//
	// ScraperId is a required field
	ScraperId *string `locationName:"scraperId" min:"1" type:"string" required:"true"`

	// The Amazon EKS cluster from which the scraper collects metrics.
	//
	// Source is a required field
	Source *Source `locationName:"source" type:"structure" required:"true"`

	// A structure that contains the current status of the scraper.
	//
	// Status is a required field
	Status *ScraperStatus `locationName:"status" type:"structure" required:"true"`

	// If there is a failure, the reason for the failure.
	StatusReason *string `locationName:"statusReason" min:"1" type:"string"`

	// (Optional) The list of tag keys and values associated with the scraper.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

The ScraperDescription structure contains the full details about one scraper in your account.

func (ScraperDescription) GoString added in v1.48.4

func (s ScraperDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScraperDescription) SetAlias added in v1.48.4

SetAlias sets the Alias field's value.

func (*ScraperDescription) SetArn added in v1.48.4

SetArn sets the Arn field's value.

func (*ScraperDescription) SetCreatedAt added in v1.48.4

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

SetCreatedAt sets the CreatedAt field's value.

func (*ScraperDescription) SetDestination added in v1.48.4

func (s *ScraperDescription) SetDestination(v *Destination) *ScraperDescription

SetDestination sets the Destination field's value.

func (*ScraperDescription) SetLastModifiedAt added in v1.48.4

func (s *ScraperDescription) SetLastModifiedAt(v time.Time) *ScraperDescription

SetLastModifiedAt sets the LastModifiedAt field's value.

func (*ScraperDescription) SetRoleArn added in v1.48.4

func (s *ScraperDescription) SetRoleArn(v string) *ScraperDescription

SetRoleArn sets the RoleArn field's value.

func (*ScraperDescription) SetScrapeConfiguration added in v1.48.4

func (s *ScraperDescription) SetScrapeConfiguration(v *ScrapeConfiguration) *ScraperDescription

SetScrapeConfiguration sets the ScrapeConfiguration field's value.

func (*ScraperDescription) SetScraperId added in v1.48.4

func (s *ScraperDescription) SetScraperId(v string) *ScraperDescription

SetScraperId sets the ScraperId field's value.

func (*ScraperDescription) SetSource added in v1.48.4

func (s *ScraperDescription) SetSource(v *Source) *ScraperDescription

SetSource sets the Source field's value.

func (*ScraperDescription) SetStatus added in v1.48.4

SetStatus sets the Status field's value.

func (*ScraperDescription) SetStatusReason added in v1.48.4

func (s *ScraperDescription) SetStatusReason(v string) *ScraperDescription

SetStatusReason sets the StatusReason field's value.

func (*ScraperDescription) SetTags added in v1.48.4

func (s *ScraperDescription) SetTags(v map[string]*string) *ScraperDescription

SetTags sets the Tags field's value.

func (ScraperDescription) String added in v1.48.4

func (s ScraperDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScraperStatus added in v1.48.4

type ScraperStatus struct {

	// The current status of the scraper.
	//
	// StatusCode is a required field
	StatusCode *string `locationName:"statusCode" type:"string" required:"true" enum:"ScraperStatusCode"`
	// contains filtered or unexported fields
}

The ScraperStatus structure contains status information about the scraper.

func (ScraperStatus) GoString added in v1.48.4

func (s ScraperStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScraperStatus) SetStatusCode added in v1.48.4

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

SetStatusCode sets the StatusCode field's value.

func (ScraperStatus) String added in v1.48.4

func (s ScraperStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ScraperSummary added in v1.48.4

type ScraperSummary struct {

	// (Optional) A name associated with the scraper.
	Alias *string `locationName:"alias" min:"1" type:"string"`

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

	// The date and time that the scraper was created.
	//
	// CreatedAt is a required field
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"`

	// The Amazon Managed Service for Prometheus workspace the scraper sends metrics
	// to.
	//
	// Destination is a required field
	Destination *Destination `locationName:"destination" type:"structure" required:"true"`

	// The date and time that the scraper was last modified.
	//
	// LastModifiedAt is a required field
	LastModifiedAt *time.Time `locationName:"lastModifiedAt" type:"timestamp" required:"true"`

	// The Amazon Resource Name (ARN) of the IAM role that provides permissions
	// for the scraper to discover and collect metrics on your behalf.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" type:"string" required:"true"`

	// The ID of the scraper.
	//
	// ScraperId is a required field
	ScraperId *string `locationName:"scraperId" min:"1" type:"string" required:"true"`

	// The Amazon EKS cluster from which the scraper collects metrics.
	//
	// Source is a required field
	Source *Source `locationName:"source" type:"structure" required:"true"`

	// A structure that contains the current status of the scraper.
	//
	// Status is a required field
	Status *ScraperStatus `locationName:"status" type:"structure" required:"true"`

	// If there is a failure, the reason for the failure.
	StatusReason *string `locationName:"statusReason" min:"1" type:"string"`

	// (Optional) The list of tag keys and values associated with the scraper.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

The ScraperSummary structure contains a summary of the details about one scraper in your account.

func (ScraperSummary) GoString added in v1.48.4

func (s ScraperSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ScraperSummary) SetAlias added in v1.48.4

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

SetAlias sets the Alias field's value.

func (*ScraperSummary) SetArn added in v1.48.4

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

SetArn sets the Arn field's value.

func (*ScraperSummary) SetCreatedAt added in v1.48.4

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

SetCreatedAt sets the CreatedAt field's value.

func (*ScraperSummary) SetDestination added in v1.48.4

func (s *ScraperSummary) SetDestination(v *Destination) *ScraperSummary

SetDestination sets the Destination field's value.

func (*ScraperSummary) SetLastModifiedAt added in v1.48.4

func (s *ScraperSummary) SetLastModifiedAt(v time.Time) *ScraperSummary

SetLastModifiedAt sets the LastModifiedAt field's value.

func (*ScraperSummary) SetRoleArn added in v1.48.4

func (s *ScraperSummary) SetRoleArn(v string) *ScraperSummary

SetRoleArn sets the RoleArn field's value.

func (*ScraperSummary) SetScraperId added in v1.48.4

func (s *ScraperSummary) SetScraperId(v string) *ScraperSummary

SetScraperId sets the ScraperId field's value.

func (*ScraperSummary) SetSource added in v1.48.4

func (s *ScraperSummary) SetSource(v *Source) *ScraperSummary

SetSource sets the Source field's value.

func (*ScraperSummary) SetStatus added in v1.48.4

func (s *ScraperSummary) SetStatus(v *ScraperStatus) *ScraperSummary

SetStatus sets the Status field's value.

func (*ScraperSummary) SetStatusReason added in v1.48.4

func (s *ScraperSummary) SetStatusReason(v string) *ScraperSummary

SetStatusReason sets the StatusReason field's value.

func (*ScraperSummary) SetTags added in v1.48.4

func (s *ScraperSummary) SetTags(v map[string]*string) *ScraperSummary

SetTags sets the Tags field's value.

func (ScraperSummary) String added in v1.48.4

func (s ScraperSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException

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

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

	// Service quotas code of the 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 code for the originating service.
	//
	// ServiceCode is a required field
	ServiceCode *string `locationName:"serviceCode" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Completing the request would cause a service quota to be exceeded.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

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

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Source added in v1.48.4

type Source struct {

	// The Amazon EKS cluster from which a scraper collects metrics.
	EksConfiguration *EksConfiguration `locationName:"eksConfiguration" type:"structure"`
	// contains filtered or unexported fields
}

The source of collected metrics for a scraper.

func (Source) GoString added in v1.48.4

func (s Source) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Source) SetEksConfiguration added in v1.48.4

func (s *Source) SetEksConfiguration(v *EksConfiguration) *Source

SetEksConfiguration sets the EksConfiguration field's value.

func (Source) String added in v1.48.4

func (s Source) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Source) Validate added in v1.48.4

func (s *Source) Validate() error

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

type TagResourceInput added in v1.40.38

type TagResourceInput struct {

	// The ARN of the workspace or rule groups namespace to apply tags to.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The list of tag keys and values to associate with the resource.
	//
	// Keys may not begin with aws:.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.40.38

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.40.38

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.40.38

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.40.38

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.40.38

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.40.38

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

func (TagResourceOutput) GoString added in v1.40.38

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.40.38

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

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

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

	// Service quotas code for the 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 code for the originating service.
	ServiceCode *string `locationName:"serviceCode" type:"string"`
	// contains filtered or unexported fields
}

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.40.38

type UntagResourceInput struct {

	// The ARN of the workspace or rule groups namespace.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The keys of the tags to remove.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.40.38

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.40.38

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.40.38

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.40.38

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.40.38

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.40.38

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

func (UntagResourceOutput) GoString added in v1.40.38

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.40.38

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateLoggingConfigurationInput added in v1.44.76

type UpdateLoggingConfigurationInput struct {

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The ARN of the CloudWatch log group to which the vended log data will be
	// published.
	//
	// LogGroupArn is a required field
	LogGroupArn *string `locationName:"logGroupArn" type:"string" required:"true"`

	// The ID of the workspace to update the logging configuration for.
	//
	// 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 UpdateLoggingConfiguration operation.

func (UpdateLoggingConfigurationInput) GoString added in v1.44.76

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLoggingConfigurationInput) SetClientToken added in v1.44.76

SetClientToken sets the ClientToken field's value.

func (*UpdateLoggingConfigurationInput) SetLogGroupArn added in v1.44.76

SetLogGroupArn sets the LogGroupArn field's value.

func (*UpdateLoggingConfigurationInput) SetWorkspaceId added in v1.44.76

SetWorkspaceId sets the WorkspaceId field's value.

func (UpdateLoggingConfigurationInput) String added in v1.44.76

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLoggingConfigurationInput) Validate added in v1.44.76

func (s *UpdateLoggingConfigurationInput) Validate() error

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

type UpdateLoggingConfigurationOutput added in v1.44.76

type UpdateLoggingConfigurationOutput struct {

	// A structure that contains the current status of the logging configuration.
	//
	// Status is a required field
	Status *LoggingConfigurationStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of an UpdateLoggingConfiguration operation.

func (UpdateLoggingConfigurationOutput) GoString added in v1.44.76

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLoggingConfigurationOutput) SetStatus added in v1.44.76

SetStatus sets the Status field's value.

func (UpdateLoggingConfigurationOutput) String added in v1.44.76

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWorkspaceAliasInput

type UpdateWorkspaceAliasInput struct {

	// The new alias for the workspace. It does not need to be unique.
	//
	// Amazon Managed Service for Prometheus will automatically strip any blank
	// spaces from the beginning and end of the alias that you specify.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// A unique identifier that you can provide to ensure the idempotency of the
	// request. Case-sensitive.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The ID of the workspace to update.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceAliasInput) SetAlias

SetAlias sets the Alias field's value.

func (*UpdateWorkspaceAliasInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*UpdateWorkspaceAliasInput) SetWorkspaceId

SetWorkspaceId sets the WorkspaceId field's value.

func (UpdateWorkspaceAliasInput) String

func (s UpdateWorkspaceAliasInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateWorkspaceAliasOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

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

	// The field that caused the error, if applicable.
	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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationExceptionField

type ValidationExceptionField struct {

	// A message describing why the field caused an exception.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The name of the field that caused an exception.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about a field passed into a request that resulted in an exception.

func (ValidationExceptionField) GoString

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationExceptionField) SetMessage

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName

SetName sets the Name field's value.

func (ValidationExceptionField) String

func (s ValidationExceptionField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceDescription

type WorkspaceDescription struct {

	// The alias that is assigned to this workspace to help identify it. It may
	// not be unique.
	Alias *string `locationName:"alias" min:"1" type:"string"`

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

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

	// (optional) If the workspace was created with a customer managed KMS key,
	// the ARN for the key used.
	KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"`

	// The Prometheus endpoint available for this workspace.
	PrometheusEndpoint *string `locationName:"prometheusEndpoint" min:"1" type:"string"`

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

	// The list of tag keys and values that are associated with the workspace.
	Tags map[string]*string `locationName:"tags" type:"map"`

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

The full details about one Amazon Managed Service for Prometheus workspace in your account.

func (WorkspaceDescription) GoString

func (s WorkspaceDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceDescription) SetAlias

SetAlias sets the Alias field's value.

func (*WorkspaceDescription) SetArn

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) SetKmsKeyArn added in v1.49.8

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

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*WorkspaceDescription) SetPrometheusEndpoint

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

SetPrometheusEndpoint sets the PrometheusEndpoint field's value.

func (*WorkspaceDescription) SetStatus

SetStatus sets the Status field's value.

func (*WorkspaceDescription) SetTags added in v1.40.38

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceStatus

type WorkspaceStatus struct {

	// The current status of the workspace.
	//
	// StatusCode is a required field
	StatusCode *string `locationName:"statusCode" type:"string" required:"true" enum:"WorkspaceStatusCode"`
	// contains filtered or unexported fields
}

The status of the workspace.

func (WorkspaceStatus) GoString

func (s WorkspaceStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceSummary

type WorkspaceSummary struct {

	// The alias that is assigned to this workspace to help identify it. It may
	// not be unique.
	Alias *string `locationName:"alias" min:"1" type:"string"`

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

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

	// (optional) If the workspace was created with a customer managed KMS key,
	// the ARN for the key used.
	KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"`

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

	// The list of tag keys and values that are associated with the workspace.
	Tags map[string]*string `locationName:"tags" type:"map"`

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

The information about one Amazon Managed Service for Prometheus workspace in your account.

func (WorkspaceSummary) GoString

func (s WorkspaceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceSummary) SetAlias

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

SetAlias sets the Alias field's value.

func (*WorkspaceSummary) SetArn

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) SetKmsKeyArn added in v1.49.8

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

SetKmsKeyArn sets the KmsKeyArn field's value.

func (*WorkspaceSummary) SetStatus

SetStatus sets the Status field's value.

func (*WorkspaceSummary) SetTags added in v1.40.38

func (s *WorkspaceSummary) SetTags(v map[string]*string) *WorkspaceSummary

SetTags sets the Tags 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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