codestarnotifications

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 6

Documentation

Overview

Package codestarnotifications provides the client and types for making API requests to AWS CodeStar Notifications.

This AWS CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Notifications API. You can use the AWS CodeStar Notifications API to work with the following objects:

Notification rules, by calling the following:

  • CreateNotificationRule, which creates a notification rule for a resource in your account.

  • DeleteNotificationRule, which deletes a notification rule.

  • DescribeNotificationRule, which provides information about a notification rule.

  • ListNotificationRules, which lists the notification rules associated with your account.

  • UpdateNotificationRule, which changes the name, events, or targets associated with a notification rule.

  • Subscribe, which subscribes a target to a notification rule.

  • Unsubscribe, which removes a target from a notification rule.

Targets, by calling the following:

  • DeleteTarget, which removes a notification rule target (SNS topic) from a notification rule.

  • ListTargets, which lists the targets associated with a notification rule.

Events, by calling the following:

  • ListEventTypes, which lists the event types you can include in a notification rule.

Tags, by calling the following:

  • ListTagsForResource, which lists the tags already associated with a notification rule in your account.

  • TagResource, which associates a tag you provide with a notification rule in your account.

  • UntagResource, which removes a tag from a notification rule in your account.

For information about how to use AWS CodeStar Notifications, see link in the CodeStarNotifications User Guide.

See https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15 for more information on this service.

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

Using the Client

To use AWS CodeStar Notifications 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 AWS CodeStar Notifications client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/codestarnotifications/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS CodeStar Notifications" // Service's name
	ServiceID   = "CodestarNotifications"      // Service's identifier
	EndpointsID = "codestar-notifications"     // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// AWS CodeStar Notifications can't create the notification rule because you
	// do not have sufficient permissions.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// AWS CodeStar Notifications can't complete the request because the resource
	// is being modified by another process. Wait a few minutes and try again.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeConfigurationException for service response error code
	// "ConfigurationException".
	//
	// Some or all of the configuration is incomplete, missing, or not valid.
	ErrCodeConfigurationException = "ConfigurationException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The value for the enumeration token used in the request to return the next
	// batch of the results is not valid.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// One of the AWS CodeStar Notifications limits has been exceeded. Limits apply
	// to accounts, notification rules, notifications, resources, and targets. For
	// more information, see Limits.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// A resource with the same name or ID already exists. Notification rule names
	// must be unique in your AWS account.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// AWS CodeStar Notifications can't find a resource that matches the provided
	// ARN.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// One or more parameter values are not valid.
	ErrCodeValidationException = "ValidationException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS CodeStar Notifications. See this package's package overview docs for details on the service.

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

func New 

func New(config aws.Config) *Client

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

Example: 

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

func (*Client) CreateNotificationRuleRequest 

func (c *Client) CreateNotificationRuleRequest(input *CreateNotificationRuleInput) CreateNotificationRuleRequest

CreateNotificationRuleRequest returns a request value for making API operation for AWS CodeStar Notifications.

Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as SNS topics) where you want to receive them. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/CreateNotificationRule

func (*Client) DeleteNotificationRuleRequest 

func (c *Client) DeleteNotificationRuleRequest(input *DeleteNotificationRuleInput) DeleteNotificationRuleRequest

DeleteNotificationRuleRequest returns a request value for making API operation for AWS CodeStar Notifications.

Deletes a notification rule for a resource. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/DeleteNotificationRule

func (*Client) DeleteTargetRequest 

func (c *Client) DeleteTargetRequest(input *DeleteTargetInput) DeleteTargetRequest

DeleteTargetRequest returns a request value for making API operation for AWS CodeStar Notifications.

Deletes a specified target for notifications. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/DeleteTarget

func (*Client) DescribeNotificationRuleRequest 

func (c *Client) DescribeNotificationRuleRequest(input *DescribeNotificationRuleInput) DescribeNotificationRuleRequest

DescribeNotificationRuleRequest returns a request value for making API operation for AWS CodeStar Notifications.

Returns information about a specified notification rule. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/DescribeNotificationRule

func (*Client) ListEventTypesRequest 

func (c *Client) ListEventTypesRequest(input *ListEventTypesInput) ListEventTypesRequest

ListEventTypesRequest returns a request value for making API operation for AWS CodeStar Notifications.

Returns information about the event types available for configuring notifications. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/ListEventTypes

func (*Client) ListNotificationRulesRequest 

func (c *Client) ListNotificationRulesRequest(input *ListNotificationRulesInput) ListNotificationRulesRequest

ListNotificationRulesRequest returns a request value for making API operation for AWS CodeStar Notifications.

Returns a list of the notification rules for an AWS account. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/ListNotificationRules

func (*Client) ListTagsForResourceRequest 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS CodeStar Notifications.

Returns a list of the tags associated with a notification rule. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/ListTagsForResource

func (*Client) ListTargetsRequest 

func (c *Client) ListTargetsRequest(input *ListTargetsInput) ListTargetsRequest

ListTargetsRequest returns a request value for making API operation for AWS CodeStar Notifications.

Returns a list of the notification rule targets for an AWS account. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/ListTargets

func (*Client) SubscribeRequest 

func (c *Client) SubscribeRequest(input *SubscribeInput) SubscribeRequest

SubscribeRequest returns a request value for making API operation for AWS CodeStar Notifications.

Creates an association between a notification rule and an SNS topic so that the associated target can receive notifications when the events described in the rule are triggered. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/Subscribe

func (*Client) TagResourceRequest 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS CodeStar Notifications.

Associates a set of provided tags with a notification rule. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/TagResource

func (*Client) UnsubscribeRequest 

func (c *Client) UnsubscribeRequest(input *UnsubscribeInput) UnsubscribeRequest

UnsubscribeRequest returns a request value for making API operation for AWS CodeStar Notifications.

Removes an association between a notification rule and an Amazon SNS topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/Unsubscribe

func (*Client) UntagResourceRequest 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS CodeStar Notifications.

Removes the association between one or more provided tags and a notification rule. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/UntagResource

func (*Client) UpdateNotificationRuleRequest 

func (c *Client) UpdateNotificationRuleRequest(input *UpdateNotificationRuleInput) UpdateNotificationRuleRequest

UpdateNotificationRuleRequest returns a request value for making API operation for AWS CodeStar Notifications.

Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications.

To add or remove tags for a notification rule, you must use TagResource and UntagResource. 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/UpdateNotificationRule

type CreateNotificationRuleInput 

type CreateNotificationRuleInput struct {

	// A unique, client-generated idempotency token that, when provided in a request,
	// ensures the request cannot be repeated with a changed parameter. If a request
	// with the same parameters is received and a token is included, the request
	// returns information about the initial request that used that token.
	//
	// The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK,
	// an idempotency token is created for you.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The level of detail to include in the notifications for this resource. BASIC
	// will include only the contents of the event as it would appear in AWS CloudWatch.
	// FULL will include any supplemental information provided by AWS CodeStar Notifications
	// and/or the service for the resource for which the notification is created.
	//
	// DetailType is a required field
	DetailType DetailType `type:"string" required:"true" enum:"true"`

	// A list of event types associated with this notification rule. For a list
	// of allowed events, see EventTypeSummary.
	//
	// EventTypeIds is a required field
	EventTypeIds []string `type:"list" required:"true"`

	// The name for the notification rule. Notifictaion rule names must be unique
	// in your AWS account.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The Amazon Resource Name (ARN) of the resource to associate with the notification
	// rule. Supported resources include pipelines in AWS CodePipeline, repositories
	// in AWS CodeCommit, and build projects in AWS CodeBuild.
	//
	// Resource is a required field
	Resource *string `type:"string" required:"true"`

	// The status of the notification rule. The default value is ENABLED. If the
	// status is set to DISABLED, notifications aren't sent for the notification
	// rule.
	Status NotificationRuleStatus `type:"string" enum:"true"`

	// A list of tags to apply to this notification rule. Key names cannot start
	// with "aws".
	Tags map[string]string `type:"map"`

	// A list of Amazon Resource Names (ARNs) of SNS topics to associate with the
	// notification rule.
	//
	// Targets is a required field
	Targets []Target `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateNotificationRuleInput) MarshalFields 

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

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

func (CreateNotificationRuleInput) String 

func (s CreateNotificationRuleInput) String() string

String returns the string representation

func (*CreateNotificationRuleInput) Validate 

func (s *CreateNotificationRuleInput) Validate() error

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

type CreateNotificationRuleOutput 

type CreateNotificationRuleOutput struct {

	// The Amazon Resource Name (ARN) of the notification rule.
	Arn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateNotificationRuleOutput) MarshalFields 

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

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

func (CreateNotificationRuleOutput) String 

func (s CreateNotificationRuleOutput) String() string

String returns the string representation

type CreateNotificationRuleRequest 

type CreateNotificationRuleRequest struct {
	*aws.Request
	Input *CreateNotificationRuleInput
	Copy  func(*CreateNotificationRuleInput) CreateNotificationRuleRequest
}

CreateNotificationRuleRequest is the request type for the CreateNotificationRule API operation.

func (CreateNotificationRuleRequest) Send 

func (r CreateNotificationRuleRequest) Send(ctx context.Context) (*CreateNotificationRuleResponse, error)

Send marshals and sends the CreateNotificationRule API request.

type CreateNotificationRuleResponse 

type CreateNotificationRuleResponse struct {
	*CreateNotificationRuleOutput
	// contains filtered or unexported fields
}

CreateNotificationRuleResponse is the response type for the CreateNotificationRule API operation.

func (*CreateNotificationRuleResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the CreateNotificationRule request.

type DeleteNotificationRuleInput 

type DeleteNotificationRuleInput struct {

	// The Amazon Resource Name (ARN) of the notification rule you want to delete.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteNotificationRuleInput) MarshalFields 

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

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

func (DeleteNotificationRuleInput) String 

func (s DeleteNotificationRuleInput) String() string

String returns the string representation

func (*DeleteNotificationRuleInput) Validate 

func (s *DeleteNotificationRuleInput) Validate() error

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

type DeleteNotificationRuleOutput 

type DeleteNotificationRuleOutput struct {

	// The Amazon Resource Name (ARN) of the deleted notification rule.
	Arn *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteNotificationRuleOutput) MarshalFields 

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

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

func (DeleteNotificationRuleOutput) String 

func (s DeleteNotificationRuleOutput) String() string

String returns the string representation

type DeleteNotificationRuleRequest 

type DeleteNotificationRuleRequest struct {
	*aws.Request
	Input *DeleteNotificationRuleInput
	Copy  func(*DeleteNotificationRuleInput) DeleteNotificationRuleRequest
}

DeleteNotificationRuleRequest is the request type for the DeleteNotificationRule API operation.

func (DeleteNotificationRuleRequest) Send 

func (r DeleteNotificationRuleRequest) Send(ctx context.Context) (*DeleteNotificationRuleResponse, error)

Send marshals and sends the DeleteNotificationRule API request.

type DeleteNotificationRuleResponse 

type DeleteNotificationRuleResponse struct {
	*DeleteNotificationRuleOutput
	// contains filtered or unexported fields
}

DeleteNotificationRuleResponse is the response type for the DeleteNotificationRule API operation.

func (*DeleteNotificationRuleResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the DeleteNotificationRule request.

type DeleteTargetInput 

type DeleteTargetInput struct {

	// A Boolean value that can be used to delete all associations with this SNS
	// topic. The default value is FALSE. If set to TRUE, all associations between
	// that target and every notification rule in your AWS account are deleted.
	ForceUnsubscribeAll *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the SNS topic to delete.
	//
	// TargetAddress is a required field
	TargetAddress *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (DeleteTargetInput) MarshalFields 

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

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

func (DeleteTargetInput) String 

func (s DeleteTargetInput) String() string

String returns the string representation

func (*DeleteTargetInput) Validate 

func (s *DeleteTargetInput) Validate() error

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

type DeleteTargetOutput 

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

func (DeleteTargetOutput) MarshalFields 

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

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

func (DeleteTargetOutput) String 

func (s DeleteTargetOutput) String() string

String returns the string representation

type DeleteTargetRequest 

type DeleteTargetRequest struct {
	*aws.Request
	Input *DeleteTargetInput
	Copy  func(*DeleteTargetInput) DeleteTargetRequest
}

DeleteTargetRequest is the request type for the DeleteTarget API operation.

func (DeleteTargetRequest) Send 

func (r DeleteTargetRequest) Send(ctx context.Context) (*DeleteTargetResponse, error)

Send marshals and sends the DeleteTarget API request.

type DeleteTargetResponse 

type DeleteTargetResponse struct {
	*DeleteTargetOutput
	// contains filtered or unexported fields
}

DeleteTargetResponse is the response type for the DeleteTarget API operation.

func (*DeleteTargetResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the DeleteTarget request.

type DescribeNotificationRuleInput 

type DescribeNotificationRuleInput struct {

	// The Amazon Resource Name (ARN) of the notification rule.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeNotificationRuleInput) MarshalFields 

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

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

func (DescribeNotificationRuleInput) String 

func (s DescribeNotificationRuleInput) String() string

String returns the string representation

func (*DescribeNotificationRuleInput) Validate 

func (s *DescribeNotificationRuleInput) Validate() error

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

type DescribeNotificationRuleOutput 

type DescribeNotificationRuleOutput struct {

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

	// The name or email alias of the person who created the notification rule.
	CreatedBy *string `min:"1" type:"string"`

	// The date and time the notification rule was created, in timestamp format.
	CreatedTimestamp *time.Time `type:"timestamp"`

	// The level of detail included in the notifications for this resource. BASIC
	// will include only the contents of the event as it would appear in AWS CloudWatch.
	// FULL will include any supplemental information provided by AWS CodeStar Notifications
	// and/or the service for the resource for which the notification is created.
	DetailType DetailType `type:"string" enum:"true"`

	// A list of the event types associated with the notification rule.
	EventTypes []EventTypeSummary `type:"list"`

	// The date and time the notification rule was most recently updated, in timestamp
	// format.
	LastModifiedTimestamp *time.Time `type:"timestamp"`

	// The name of the notification rule.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The Amazon Resource Name (ARN) of the resource associated with the notification
	// rule.
	Resource *string `type:"string"`

	// The status of the notification rule. Valid statuses are on (sending notifications)
	// or off (not sending notifications).
	Status NotificationRuleStatus `type:"string" enum:"true"`

	// The tags associated with the notification rule.
	Tags map[string]string `type:"map"`

	// A list of the SNS topics associated with the notification rule.
	Targets []TargetSummary `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeNotificationRuleOutput) MarshalFields 

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

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

func (DescribeNotificationRuleOutput) String 

func (s DescribeNotificationRuleOutput) String() string

String returns the string representation

type DescribeNotificationRuleRequest 

type DescribeNotificationRuleRequest struct {
	*aws.Request
	Input *DescribeNotificationRuleInput
	Copy  func(*DescribeNotificationRuleInput) DescribeNotificationRuleRequest
}

DescribeNotificationRuleRequest is the request type for the DescribeNotificationRule API operation.

func (DescribeNotificationRuleRequest) Send 

func (r DescribeNotificationRuleRequest) Send(ctx context.Context) (*DescribeNotificationRuleResponse, error)

Send marshals and sends the DescribeNotificationRule API request.

type DescribeNotificationRuleResponse 

type DescribeNotificationRuleResponse struct {
	*DescribeNotificationRuleOutput
	// contains filtered or unexported fields
}

DescribeNotificationRuleResponse is the response type for the DescribeNotificationRule API operation.

func (*DescribeNotificationRuleResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the DescribeNotificationRule request.

type DetailType 

type DetailType string
const (
	DetailTypeBasic DetailType = "BASIC"
	DetailTypeFull  DetailType = "FULL"
)

Enum values for DetailType

func (DetailType) MarshalValue 

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

func (DetailType) MarshalValueBuf 

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

type EventTypeSummary 

type EventTypeSummary struct {

	// The system-generated ID of the event.
	EventTypeId *string `min:"1" type:"string"`

	// The name of the event.
	EventTypeName *string `type:"string"`

	// The resource type of the event.
	ResourceType *string `min:"1" type:"string"`

	// The name of the service for which the event applies.
	ServiceName *string `type:"string"`
	// contains filtered or unexported fields
}

Returns information about an event that has triggered a notification rule.

func (EventTypeSummary) MarshalFields 

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

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

func (EventTypeSummary) String 

func (s EventTypeSummary) String() string

String returns the string representation

type ListEventTypesFilter 

type ListEventTypesFilter struct {

	// The system-generated name of the filter type you want to filter by.
	//
	// Name is a required field
	Name ListEventTypesFilterName `type:"string" required:"true" enum:"true"`

	// The name of the resource type (for example, pipeline) or service name (for
	// example, CodePipeline) that you want to filter by.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about a filter to apply to the list of returned event types. You can filter by resource type or service name.

func (ListEventTypesFilter) MarshalFields 

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

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

func (ListEventTypesFilter) String 

func (s ListEventTypesFilter) String() string

String returns the string representation

func (*ListEventTypesFilter) Validate 

func (s *ListEventTypesFilter) Validate() error

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

type ListEventTypesFilterName 

type ListEventTypesFilterName string
const (
	ListEventTypesFilterNameResourceType ListEventTypesFilterName = "RESOURCE_TYPE"
	ListEventTypesFilterNameServiceName  ListEventTypesFilterName = "SERVICE_NAME"
)

Enum values for ListEventTypesFilterName

func (ListEventTypesFilterName) MarshalValue 

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

func (ListEventTypesFilterName) MarshalValueBuf 

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

type ListEventTypesInput 

type ListEventTypesInput struct {

	// The filters to use to return information by service or resource type.
	Filters []ListEventTypesFilter `type:"list"`

	// A non-negative integer used to limit the number of returned results. The
	// default number is 50. The maximum number of results that can be returned
	// is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// An enumeration token that, when provided in a request, returns the next batch
	// of the results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListEventTypesInput) MarshalFields 

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

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

func (ListEventTypesInput) String 

func (s ListEventTypesInput) String() string

String returns the string representation

func (*ListEventTypesInput) Validate 

func (s *ListEventTypesInput) Validate() error

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

type ListEventTypesOutput 

type ListEventTypesOutput struct {

	// Information about each event, including service name, resource type, event
	// ID, and event name.
	EventTypes []EventTypeSummary `type:"list"`

	// An enumeration token that can be used in a request to return the next batch
	// of the results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListEventTypesOutput) MarshalFields 

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

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

func (ListEventTypesOutput) String 

func (s ListEventTypesOutput) String() string

String returns the string representation

type ListEventTypesPaginator 

type ListEventTypesPaginator struct {
	aws.Pager
}

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

func NewListEventTypesPaginator 

func NewListEventTypesPaginator(req ListEventTypesRequest) ListEventTypesPaginator

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

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

// Example iterating over pages.
req := client.ListEventTypesRequest(input)
p := codestarnotifications.NewListEventTypesRequestPaginator(req)

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

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

func (*ListEventTypesPaginator) CurrentPage 

func (p *ListEventTypesPaginator) CurrentPage() *ListEventTypesOutput

type ListEventTypesRequest 

type ListEventTypesRequest struct {
	*aws.Request
	Input *ListEventTypesInput
	Copy  func(*ListEventTypesInput) ListEventTypesRequest
}

ListEventTypesRequest is the request type for the ListEventTypes API operation.

func (ListEventTypesRequest) Send 

func (r ListEventTypesRequest) Send(ctx context.Context) (*ListEventTypesResponse, error)

Send marshals and sends the ListEventTypes API request.

type ListEventTypesResponse 

type ListEventTypesResponse struct {
	*ListEventTypesOutput
	// contains filtered or unexported fields
}

ListEventTypesResponse is the response type for the ListEventTypes API operation.

func (*ListEventTypesResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the ListEventTypes request.

type ListNotificationRulesFilter 

type ListNotificationRulesFilter struct {

	// The name of the attribute you want to use to filter the returned notification
	// rules.
	//
	// Name is a required field
	Name ListNotificationRulesFilterName `type:"string" required:"true" enum:"true"`

	// The value of the attribute you want to use to filter the returned notification
	// rules. For example, if you specify filtering by RESOURCE in Name, you might
	// specify the ARN of a pipeline in AWS CodePipeline for the value.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about a filter to apply to the list of returned notification rules. You can filter by event type, owner, resource, or target.

func (ListNotificationRulesFilter) MarshalFields 

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

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

func (ListNotificationRulesFilter) String 

func (s ListNotificationRulesFilter) String() string

String returns the string representation

func (*ListNotificationRulesFilter) Validate 

func (s *ListNotificationRulesFilter) Validate() error

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

type ListNotificationRulesFilterName 

type ListNotificationRulesFilterName string
const (
	ListNotificationRulesFilterNameEventTypeId   ListNotificationRulesFilterName = "EVENT_TYPE_ID"
	ListNotificationRulesFilterNameCreatedBy     ListNotificationRulesFilterName = "CREATED_BY"
	ListNotificationRulesFilterNameResource      ListNotificationRulesFilterName = "RESOURCE"
	ListNotificationRulesFilterNameTargetAddress ListNotificationRulesFilterName = "TARGET_ADDRESS"
)

Enum values for ListNotificationRulesFilterName

func (ListNotificationRulesFilterName) MarshalValue 

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

func (ListNotificationRulesFilterName) MarshalValueBuf 

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

type ListNotificationRulesInput 

type ListNotificationRulesInput struct {

	// The filters to use to return information by service or resource type. For
	// valid values, see ListNotificationRulesFilter.
	//
	// A filter with the same name can appear more than once when used with OR statements.
	// Filters with different names should be applied with AND statements.
	Filters []ListNotificationRulesFilter `type:"list"`

	// A non-negative integer used to limit the number of returned results. The
	// maximum number of results that can be returned is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// An enumeration token that, when provided in a request, returns the next batch
	// of the results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListNotificationRulesInput) MarshalFields 

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

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

func (ListNotificationRulesInput) String 

func (s ListNotificationRulesInput) String() string

String returns the string representation

func (*ListNotificationRulesInput) Validate 

func (s *ListNotificationRulesInput) Validate() error

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

type ListNotificationRulesOutput 

type ListNotificationRulesOutput struct {

	// An enumeration token that can be used in a request to return the next batch
	// of the results.
	NextToken *string `type:"string"`

	// The list of notification rules for the AWS account, by Amazon Resource Name
	// (ARN) and ID.
	NotificationRules []NotificationRuleSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListNotificationRulesOutput) MarshalFields 

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

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

func (ListNotificationRulesOutput) String 

func (s ListNotificationRulesOutput) String() string

String returns the string representation

type ListNotificationRulesPaginator 

type ListNotificationRulesPaginator struct {
	aws.Pager
}

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

func NewListNotificationRulesPaginator 

func NewListNotificationRulesPaginator(req ListNotificationRulesRequest) ListNotificationRulesPaginator

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

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

// Example iterating over pages.
req := client.ListNotificationRulesRequest(input)
p := codestarnotifications.NewListNotificationRulesRequestPaginator(req)

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

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

func (*ListNotificationRulesPaginator) CurrentPage 

func (p *ListNotificationRulesPaginator) CurrentPage() *ListNotificationRulesOutput

type ListNotificationRulesRequest 

type ListNotificationRulesRequest struct {
	*aws.Request
	Input *ListNotificationRulesInput
	Copy  func(*ListNotificationRulesInput) ListNotificationRulesRequest
}

ListNotificationRulesRequest is the request type for the ListNotificationRules API operation.

func (ListNotificationRulesRequest) Send 

func (r ListNotificationRulesRequest) Send(ctx context.Context) (*ListNotificationRulesResponse, error)

Send marshals and sends the ListNotificationRules API request.

type ListNotificationRulesResponse 

type ListNotificationRulesResponse struct {
	*ListNotificationRulesOutput
	// contains filtered or unexported fields
}

ListNotificationRulesResponse is the response type for the ListNotificationRules API operation.

func (*ListNotificationRulesResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the ListNotificationRules request.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) for the notification rule.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) MarshalFields 

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

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

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The tags associated with the notification rule.
	Tags map[string]string `type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) MarshalFields 

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

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

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ListTargetsFilter 

type ListTargetsFilter struct {

	// The name of the attribute you want to use to filter the returned targets.
	//
	// Name is a required field
	Name ListTargetsFilterName `type:"string" required:"true" enum:"true"`

	// The value of the attribute you want to use to filter the returned targets.
	// For example, if you specify SNS for the Target type, you could specify an
	// Amazon Resource Name (ARN) for a topic as the value.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about a filter to apply to the list of returned targets. You can filter by target type, address, or status. For example, to filter results to notification rules that have active Amazon SNS topics as targets, you could specify a ListTargetsFilter Name as TargetType and a Value of SNS, and a Name of TARGET_STATUS and a Value of ACTIVE.

func (ListTargetsFilter) MarshalFields 

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

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

func (ListTargetsFilter) String 

func (s ListTargetsFilter) String() string

String returns the string representation

func (*ListTargetsFilter) Validate 

func (s *ListTargetsFilter) Validate() error

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

type ListTargetsFilterName 

type ListTargetsFilterName string
const (
	ListTargetsFilterNameTargetType    ListTargetsFilterName = "TARGET_TYPE"
	ListTargetsFilterNameTargetAddress ListTargetsFilterName = "TARGET_ADDRESS"
	ListTargetsFilterNameTargetStatus  ListTargetsFilterName = "TARGET_STATUS"
)

Enum values for ListTargetsFilterName

func (ListTargetsFilterName) MarshalValue 

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

func (ListTargetsFilterName) MarshalValueBuf 

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

type ListTargetsInput 

type ListTargetsInput struct {

	// The filters to use to return information by service or resource type. Valid
	// filters include target type, target address, and target status.
	//
	// A filter with the same name can appear more than once when used with OR statements.
	// Filters with different names should be applied with AND statements.
	Filters []ListTargetsFilter `type:"list"`

	// A non-negative integer used to limit the number of returned results. The
	// maximum number of results that can be returned is 100.
	MaxResults *int64 `min:"1" type:"integer"`

	// An enumeration token that, when provided in a request, returns the next batch
	// of the results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListTargetsInput) MarshalFields 

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

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

func (ListTargetsInput) String 

func (s ListTargetsInput) String() string

String returns the string representation

func (*ListTargetsInput) Validate 

func (s *ListTargetsInput) Validate() error

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

type ListTargetsOutput 

type ListTargetsOutput struct {

	// An enumeration token that can be used in a request to return the next batch
	// of results.
	NextToken *string `type:"string"`

	// The list of notification rule targets.
	Targets []TargetSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListTargetsOutput) MarshalFields 

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

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

func (ListTargetsOutput) String 

func (s ListTargetsOutput) String() string

String returns the string representation

type ListTargetsPaginator 

type ListTargetsPaginator struct {
	aws.Pager
}

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

func NewListTargetsPaginator 

func NewListTargetsPaginator(req ListTargetsRequest) ListTargetsPaginator

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

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

// Example iterating over pages.
req := client.ListTargetsRequest(input)
p := codestarnotifications.NewListTargetsRequestPaginator(req)

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

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

func (*ListTargetsPaginator) CurrentPage 

func (p *ListTargetsPaginator) CurrentPage() *ListTargetsOutput

type ListTargetsRequest 

type ListTargetsRequest struct {
	*aws.Request
	Input *ListTargetsInput
	Copy  func(*ListTargetsInput) ListTargetsRequest
}

ListTargetsRequest is the request type for the ListTargets API operation.

func (ListTargetsRequest) Send 

func (r ListTargetsRequest) Send(ctx context.Context) (*ListTargetsResponse, error)

Send marshals and sends the ListTargets API request.

type ListTargetsResponse 

type ListTargetsResponse struct {
	*ListTargetsOutput
	// contains filtered or unexported fields
}

ListTargetsResponse is the response type for the ListTargets API operation.

func (*ListTargetsResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the ListTargets request.

type NotificationRuleStatus 

type NotificationRuleStatus string
const (
	NotificationRuleStatusEnabled  NotificationRuleStatus = "ENABLED"
	NotificationRuleStatusDisabled NotificationRuleStatus = "DISABLED"
)

Enum values for NotificationRuleStatus

func (NotificationRuleStatus) MarshalValue 

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

func (NotificationRuleStatus) MarshalValueBuf 

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

type NotificationRuleSummary 

type NotificationRuleSummary struct {

	// The Amazon Resource Name (ARN) of the notification rule.
	Arn *string `type:"string"`

	// The unique ID of the notification rule.
	Id *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about a specified notification rule.

func (NotificationRuleSummary) MarshalFields 

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

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

func (NotificationRuleSummary) String 

func (s NotificationRuleSummary) String() string

String returns the string representation

type SubscribeInput 

type SubscribeInput struct {

	// The Amazon Resource Name (ARN) of the notification rule for which you want
	// to create the association.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// An enumeration token that, when provided in a request, returns the next batch
	// of the results.
	ClientRequestToken *string `min:"1" type:"string"`

	// Information about the SNS topics associated with a notification rule.
	//
	// Target is a required field
	Target *Target `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (SubscribeInput) MarshalFields 

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

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

func (SubscribeInput) String 

func (s SubscribeInput) String() string

String returns the string representation

func (*SubscribeInput) Validate 

func (s *SubscribeInput) Validate() error

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

type SubscribeOutput 

type SubscribeOutput struct {

	// The Amazon Resource Name (ARN) of the notification rule for which you have
	// created assocations.
	Arn *string `type:"string"`
	// contains filtered or unexported fields
}

func (SubscribeOutput) MarshalFields 

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

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

func (SubscribeOutput) String 

func (s SubscribeOutput) String() string

String returns the string representation

type SubscribeRequest 

type SubscribeRequest struct {
	*aws.Request
	Input *SubscribeInput
	Copy  func(*SubscribeInput) SubscribeRequest
}

SubscribeRequest is the request type for the Subscribe API operation.

func (SubscribeRequest) Send 

func (r SubscribeRequest) Send(ctx context.Context) (*SubscribeResponse, error)

Send marshals and sends the Subscribe API request.

type SubscribeResponse 

type SubscribeResponse struct {
	*SubscribeOutput
	// contains filtered or unexported fields
}

SubscribeResponse is the response type for the Subscribe API operation.

func (*SubscribeResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the Subscribe request.

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the notification rule to tag.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The list of tags to associate with the resource. Tag key names cannot start
	// with "aws".
	//
	// Tags is a required field
	Tags map[string]string `type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) MarshalFields 

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

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

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

type TagResourceOutput struct {

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

func (TagResourceOutput) MarshalFields 

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

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

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse 

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

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the TagResource request.

type Target 

type Target struct {

	// The Amazon Resource Name (ARN) of the SNS topic.
	TargetAddress *string `min:"1" type:"string" sensitive:"true"`

	// The target type. Can be an Amazon SNS topic.
	TargetType *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the SNS topics associated with a notification rule.

func (Target) MarshalFields 

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

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

func (Target) String 

func (s Target) String() string

String returns the string representation

func (*Target) Validate 

func (s *Target) Validate() error

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

type TargetStatus 

type TargetStatus string
const (
	TargetStatusPending     TargetStatus = "PENDING"
	TargetStatusActive      TargetStatus = "ACTIVE"
	TargetStatusUnreachable TargetStatus = "UNREACHABLE"
	TargetStatusInactive    TargetStatus = "INACTIVE"
	TargetStatusDeactivated TargetStatus = "DEACTIVATED"
)

Enum values for TargetStatus

func (TargetStatus) MarshalValue 

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

func (TargetStatus) MarshalValueBuf 

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

type TargetSummary 

type TargetSummary struct {

	// The Amazon Resource Name (ARN) of the SNS topic.
	TargetAddress *string `min:"1" type:"string" sensitive:"true"`

	// The status of the target.
	TargetStatus TargetStatus `type:"string" enum:"true"`

	// The type of the target (for example, SNS).
	TargetType *string `type:"string"`
	// contains filtered or unexported fields
}

Information about the targets specified for a notification rule.

func (TargetSummary) MarshalFields 

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

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

func (TargetSummary) String 

func (s TargetSummary) String() string

String returns the string representation

type UnsubscribeInput 

type UnsubscribeInput struct {

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

	// The ARN of the SNS topic to unsubscribe from the notification rule.
	//
	// TargetAddress is a required field
	TargetAddress *string `min:"1" type:"string" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UnsubscribeInput) MarshalFields 

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

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

func (UnsubscribeInput) String 

func (s UnsubscribeInput) String() string

String returns the string representation

func (*UnsubscribeInput) Validate 

func (s *UnsubscribeInput) Validate() error

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

type UnsubscribeOutput 

type UnsubscribeOutput struct {

	// The Amazon Resource Name (ARN) of the the notification rule from which you
	// have removed a subscription.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UnsubscribeOutput) MarshalFields 

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

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

func (UnsubscribeOutput) String 

func (s UnsubscribeOutput) String() string

String returns the string representation

type UnsubscribeRequest 

type UnsubscribeRequest struct {
	*aws.Request
	Input *UnsubscribeInput
	Copy  func(*UnsubscribeInput) UnsubscribeRequest
}

UnsubscribeRequest is the request type for the Unsubscribe API operation.

func (UnsubscribeRequest) Send 

func (r UnsubscribeRequest) Send(ctx context.Context) (*UnsubscribeResponse, error)

Send marshals and sends the Unsubscribe API request.

type UnsubscribeResponse 

type UnsubscribeResponse struct {
	*UnsubscribeOutput
	// contains filtered or unexported fields
}

UnsubscribeResponse is the response type for the Unsubscribe API operation.

func (*UnsubscribeResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the Unsubscribe request.

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the notification rule from which to remove
	// the tags.
	//
	// Arn is a required field
	Arn *string `type:"string" required:"true"`

	// The key names of the tags to remove.
	//
	// TagKeys is a required field
	TagKeys []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) MarshalFields 

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

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

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

func (UntagResourceOutput) MarshalFields 

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

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

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse 

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

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateNotificationRuleInput 

type UpdateNotificationRuleInput struct {

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

	// The level of detail to include in the notifications for this resource. BASIC
	// will include only the contents of the event as it would appear in AWS CloudWatch.
	// FULL will include any supplemental information provided by AWS CodeStar Notifications
	// and/or the service for the resource for which the notification is created.
	DetailType DetailType `type:"string" enum:"true"`

	// A list of event types associated with this notification rule.
	EventTypeIds []string `type:"list"`

	// The name of the notification rule.
	Name *string `min:"1" type:"string" sensitive:"true"`

	// The status of the notification rule. Valid statuses include enabled (sending
	// notifications) or disabled (not sending notifications).
	Status NotificationRuleStatus `type:"string" enum:"true"`

	// The address and type of the targets to receive notifications from this notification
	// rule.
	Targets []Target `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateNotificationRuleInput) MarshalFields 

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

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

func (UpdateNotificationRuleInput) String 

func (s UpdateNotificationRuleInput) String() string

String returns the string representation

func (*UpdateNotificationRuleInput) Validate 

func (s *UpdateNotificationRuleInput) Validate() error

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

type UpdateNotificationRuleOutput 

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

func (UpdateNotificationRuleOutput) MarshalFields 

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

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

func (UpdateNotificationRuleOutput) String 

func (s UpdateNotificationRuleOutput) String() string

String returns the string representation

type UpdateNotificationRuleRequest 

type UpdateNotificationRuleRequest struct {
	*aws.Request
	Input *UpdateNotificationRuleInput
	Copy  func(*UpdateNotificationRuleInput) UpdateNotificationRuleRequest
}

UpdateNotificationRuleRequest is the request type for the UpdateNotificationRule API operation.

func (UpdateNotificationRuleRequest) Send 

func (r UpdateNotificationRuleRequest) Send(ctx context.Context) (*UpdateNotificationRuleResponse, error)

Send marshals and sends the UpdateNotificationRule API request.

type UpdateNotificationRuleResponse 

type UpdateNotificationRuleResponse struct {
	*UpdateNotificationRuleOutput
	// contains filtered or unexported fields
}

UpdateNotificationRuleResponse is the response type for the UpdateNotificationRule API operation.

func (*UpdateNotificationRuleResponse) SDKResponseMetdata 

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

SDKResponseMetdata returns the response metadata for the UpdateNotificationRule request.

Source Files

View all Source files

Directories

Path Synopsis
Package codestarnotificationsiface provides an interface to enable mocking the AWS CodeStar Notifications service client for testing your code.
 Package codestarnotificationsiface provides an interface to enable mocking the AWS CodeStar Notifications service client for testing your code.

Jump to

Keyboard shortcuts

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