aws-sdk-go: github.com/aws/aws-sdk-go/service/codestarnotifications Index | Files | Directories

package codestarnotifications

import "github.com/aws/aws-sdk-go/service/codestarnotifications"

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

Index

Package Files

api.go doc.go errors.go service.go

Constants

const (
    // DetailTypeBasic is a DetailType enum value
    DetailTypeBasic = "BASIC"

    // DetailTypeFull is a DetailType enum value
    DetailTypeFull = "FULL"
)
const (
    // ListEventTypesFilterNameResourceType is a ListEventTypesFilterName enum value
    ListEventTypesFilterNameResourceType = "RESOURCE_TYPE"

    // ListEventTypesFilterNameServiceName is a ListEventTypesFilterName enum value
    ListEventTypesFilterNameServiceName = "SERVICE_NAME"
)
const (
    // ListNotificationRulesFilterNameEventTypeId is a ListNotificationRulesFilterName enum value
    ListNotificationRulesFilterNameEventTypeId = "EVENT_TYPE_ID"

    // ListNotificationRulesFilterNameCreatedBy is a ListNotificationRulesFilterName enum value
    ListNotificationRulesFilterNameCreatedBy = "CREATED_BY"

    // ListNotificationRulesFilterNameResource is a ListNotificationRulesFilterName enum value
    ListNotificationRulesFilterNameResource = "RESOURCE"

    // ListNotificationRulesFilterNameTargetAddress is a ListNotificationRulesFilterName enum value
    ListNotificationRulesFilterNameTargetAddress = "TARGET_ADDRESS"
)
const (
    // ListTargetsFilterNameTargetType is a ListTargetsFilterName enum value
    ListTargetsFilterNameTargetType = "TARGET_TYPE"

    // ListTargetsFilterNameTargetAddress is a ListTargetsFilterName enum value
    ListTargetsFilterNameTargetAddress = "TARGET_ADDRESS"

    // ListTargetsFilterNameTargetStatus is a ListTargetsFilterName enum value
    ListTargetsFilterNameTargetStatus = "TARGET_STATUS"
)
const (
    // NotificationRuleStatusEnabled is a NotificationRuleStatus enum value
    NotificationRuleStatusEnabled = "ENABLED"

    // NotificationRuleStatusDisabled is a NotificationRuleStatus enum value
    NotificationRuleStatusDisabled = "DISABLED"
)
const (
    // TargetStatusPending is a TargetStatus enum value
    TargetStatusPending = "PENDING"

    // TargetStatusActive is a TargetStatus enum value
    TargetStatusActive = "ACTIVE"

    // TargetStatusUnreachable is a TargetStatus enum value
    TargetStatusUnreachable = "UNREACHABLE"

    // TargetStatusInactive is a TargetStatus enum value
    TargetStatusInactive = "INACTIVE"

    // TargetStatusDeactivated is a TargetStatus enum value
    TargetStatusDeactivated = "DEACTIVATED"
)
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"
)
const (
    ServiceName = "codestar notifications" // Name of service.
    EndpointsID = "codestar-notifications" // ID to lookup a service endpoint with.
    ServiceID   = "codestar notifications" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type CodeStarNotifications Uses

type CodeStarNotifications struct {
    *client.Client
}

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

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

func New Uses

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

New creates a new instance of the CodeStarNotifications 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 CodeStarNotifications client from just a session.
svc := codestarnotifications.New(mySession)

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

func (*CodeStarNotifications) CreateNotificationRule Uses

func (c *CodeStarNotifications) CreateNotificationRule(input *CreateNotificationRuleInput) (*CreateNotificationRuleOutput, error)

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

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 AWS CodeStar Notifications's API operation CreateNotificationRule for usage and error information.

Returned Error Codes:

* ErrCodeResourceAlreadyExistsException "ResourceAlreadyExistsException"
A resource with the same name or ID already exists. Notification rule names
must be unique in your AWS account.

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

* ErrCodeLimitExceededException "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.

* ErrCodeConfigurationException "ConfigurationException"
Some or all of the configuration is incomplete, missing, or not valid.

* ErrCodeConcurrentModificationException "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.

* ErrCodeAccessDeniedException "AccessDeniedException"
AWS CodeStar Notifications can't create the notification rule because you
do not have sufficient permissions.

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

func (*CodeStarNotifications) CreateNotificationRuleRequest Uses

func (c *CodeStarNotifications) CreateNotificationRuleRequest(input *CreateNotificationRuleInput) (req *request.Request, output *CreateNotificationRuleOutput)

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

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

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

func (*CodeStarNotifications) CreateNotificationRuleWithContext Uses

func (c *CodeStarNotifications) CreateNotificationRuleWithContext(ctx aws.Context, input *CreateNotificationRuleInput, opts ...request.Option) (*CreateNotificationRuleOutput, error)

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

See CreateNotificationRule 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 (*CodeStarNotifications) DeleteNotificationRule Uses

func (c *CodeStarNotifications) DeleteNotificationRule(input *DeleteNotificationRuleInput) (*DeleteNotificationRuleOutput, error)

DeleteNotificationRule API operation for AWS CodeStar Notifications.

Deletes a notification rule for a resource.

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 AWS CodeStar Notifications's API operation DeleteNotificationRule for usage and error information.

Returned Error Codes:

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

* ErrCodeLimitExceededException "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.

* ErrCodeConcurrentModificationException "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.

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

func (*CodeStarNotifications) DeleteNotificationRuleRequest Uses

func (c *CodeStarNotifications) DeleteNotificationRuleRequest(input *DeleteNotificationRuleInput) (req *request.Request, output *DeleteNotificationRuleOutput)

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

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

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

func (*CodeStarNotifications) DeleteNotificationRuleWithContext Uses

func (c *CodeStarNotifications) DeleteNotificationRuleWithContext(ctx aws.Context, input *DeleteNotificationRuleInput, opts ...request.Option) (*DeleteNotificationRuleOutput, error)

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

See DeleteNotificationRule 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 (*CodeStarNotifications) DeleteTarget Uses

func (c *CodeStarNotifications) DeleteTarget(input *DeleteTargetInput) (*DeleteTargetOutput, error)

DeleteTarget API operation for AWS CodeStar Notifications.

Deletes a specified target for notifications.

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 AWS CodeStar Notifications's API operation DeleteTarget for usage and error information.

Returned Error Codes:

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

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

func (*CodeStarNotifications) DeleteTargetRequest Uses

func (c *CodeStarNotifications) DeleteTargetRequest(input *DeleteTargetInput) (req *request.Request, output *DeleteTargetOutput)

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

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

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

func (*CodeStarNotifications) DeleteTargetWithContext Uses

func (c *CodeStarNotifications) DeleteTargetWithContext(ctx aws.Context, input *DeleteTargetInput, opts ...request.Option) (*DeleteTargetOutput, error)

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

See DeleteTarget 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 (*CodeStarNotifications) DescribeNotificationRule Uses

func (c *CodeStarNotifications) DescribeNotificationRule(input *DescribeNotificationRuleInput) (*DescribeNotificationRuleOutput, error)

DescribeNotificationRule API operation for AWS CodeStar Notifications.

Returns information about a specified notification rule.

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 AWS CodeStar Notifications's API operation DescribeNotificationRule for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
AWS CodeStar Notifications can't find a resource that matches the provided
ARN.

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

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

func (*CodeStarNotifications) DescribeNotificationRuleRequest Uses

func (c *CodeStarNotifications) DescribeNotificationRuleRequest(input *DescribeNotificationRuleInput) (req *request.Request, output *DescribeNotificationRuleOutput)

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

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

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

func (*CodeStarNotifications) DescribeNotificationRuleWithContext Uses

func (c *CodeStarNotifications) DescribeNotificationRuleWithContext(ctx aws.Context, input *DescribeNotificationRuleInput, opts ...request.Option) (*DescribeNotificationRuleOutput, error)

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

See DescribeNotificationRule 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 (*CodeStarNotifications) ListEventTypes Uses

func (c *CodeStarNotifications) ListEventTypes(input *ListEventTypesInput) (*ListEventTypesOutput, error)

ListEventTypes API operation for AWS CodeStar Notifications.

Returns information about the event types available for configuring notifications.

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 AWS CodeStar Notifications's API operation ListEventTypes for usage and error information.

Returned Error Codes:

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
The value for the enumeration token used in the request to return the next
batch of the results is not valid.

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

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

func (*CodeStarNotifications) ListEventTypesPages Uses

func (c *CodeStarNotifications) ListEventTypesPages(input *ListEventTypesInput, fn func(*ListEventTypesOutput, bool) bool) error

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

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

func (*CodeStarNotifications) ListEventTypesPagesWithContext Uses

func (c *CodeStarNotifications) ListEventTypesPagesWithContext(ctx aws.Context, input *ListEventTypesInput, fn func(*ListEventTypesOutput, bool) bool, opts ...request.Option) error

ListEventTypesPagesWithContext same as ListEventTypesPages 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 (*CodeStarNotifications) ListEventTypesRequest Uses

func (c *CodeStarNotifications) ListEventTypesRequest(input *ListEventTypesInput) (req *request.Request, output *ListEventTypesOutput)

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

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

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

func (*CodeStarNotifications) ListEventTypesWithContext Uses

func (c *CodeStarNotifications) ListEventTypesWithContext(ctx aws.Context, input *ListEventTypesInput, opts ...request.Option) (*ListEventTypesOutput, error)

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

See ListEventTypes 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 (*CodeStarNotifications) ListNotificationRules Uses

func (c *CodeStarNotifications) ListNotificationRules(input *ListNotificationRulesInput) (*ListNotificationRulesOutput, error)

ListNotificationRules API operation for AWS CodeStar Notifications.

Returns a list of the notification rules for an AWS 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 AWS CodeStar Notifications's API operation ListNotificationRules for usage and error information.

Returned Error Codes:

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
The value for the enumeration token used in the request to return the next
batch of the results is not valid.

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

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

func (*CodeStarNotifications) ListNotificationRulesPages Uses

func (c *CodeStarNotifications) ListNotificationRulesPages(input *ListNotificationRulesInput, fn func(*ListNotificationRulesOutput, bool) bool) error

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

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

func (*CodeStarNotifications) ListNotificationRulesPagesWithContext Uses

func (c *CodeStarNotifications) ListNotificationRulesPagesWithContext(ctx aws.Context, input *ListNotificationRulesInput, fn func(*ListNotificationRulesOutput, bool) bool, opts ...request.Option) error

ListNotificationRulesPagesWithContext same as ListNotificationRulesPages 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 (*CodeStarNotifications) ListNotificationRulesRequest Uses

func (c *CodeStarNotifications) ListNotificationRulesRequest(input *ListNotificationRulesInput) (req *request.Request, output *ListNotificationRulesOutput)

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

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

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

func (*CodeStarNotifications) ListNotificationRulesWithContext Uses

func (c *CodeStarNotifications) ListNotificationRulesWithContext(ctx aws.Context, input *ListNotificationRulesInput, opts ...request.Option) (*ListNotificationRulesOutput, error)

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

See ListNotificationRules 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 (*CodeStarNotifications) ListTagsForResource Uses

func (c *CodeStarNotifications) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS CodeStar Notifications.

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

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 AWS CodeStar Notifications's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
AWS CodeStar Notifications can't find a resource that matches the provided
ARN.

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

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

func (*CodeStarNotifications) ListTagsForResourceRequest Uses

func (c *CodeStarNotifications) 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/codestar-notifications-2019-10-15/ListTagsForResource

func (*CodeStarNotifications) ListTagsForResourceWithContext Uses

func (c *CodeStarNotifications) 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 (*CodeStarNotifications) ListTargets Uses

func (c *CodeStarNotifications) ListTargets(input *ListTargetsInput) (*ListTargetsOutput, error)

ListTargets API operation for AWS CodeStar Notifications.

Returns a list of the notification rule targets for an AWS 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 AWS CodeStar Notifications's API operation ListTargets for usage and error information.

Returned Error Codes:

* ErrCodeInvalidNextTokenException "InvalidNextTokenException"
The value for the enumeration token used in the request to return the next
batch of the results is not valid.

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

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

func (*CodeStarNotifications) ListTargetsPages Uses

func (c *CodeStarNotifications) ListTargetsPages(input *ListTargetsInput, fn func(*ListTargetsOutput, bool) bool) error

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

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

func (*CodeStarNotifications) ListTargetsPagesWithContext Uses

func (c *CodeStarNotifications) ListTargetsPagesWithContext(ctx aws.Context, input *ListTargetsInput, fn func(*ListTargetsOutput, bool) bool, opts ...request.Option) error

ListTargetsPagesWithContext same as ListTargetsPages 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 (*CodeStarNotifications) ListTargetsRequest Uses

func (c *CodeStarNotifications) ListTargetsRequest(input *ListTargetsInput) (req *request.Request, output *ListTargetsOutput)

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

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

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

func (*CodeStarNotifications) ListTargetsWithContext Uses

func (c *CodeStarNotifications) ListTargetsWithContext(ctx aws.Context, input *ListTargetsInput, opts ...request.Option) (*ListTargetsOutput, error)

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

See ListTargets 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 (*CodeStarNotifications) Subscribe Uses

func (c *CodeStarNotifications) Subscribe(input *SubscribeInput) (*SubscribeOutput, error)

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

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 AWS CodeStar Notifications's API operation Subscribe for usage and error information.

Returned Error Codes:

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
AWS CodeStar Notifications can't find a resource that matches the provided
ARN.

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

func (*CodeStarNotifications) SubscribeRequest Uses

func (c *CodeStarNotifications) SubscribeRequest(input *SubscribeInput) (req *request.Request, output *SubscribeOutput)

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

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

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

func (*CodeStarNotifications) SubscribeWithContext Uses

func (c *CodeStarNotifications) SubscribeWithContext(ctx aws.Context, input *SubscribeInput, opts ...request.Option) (*SubscribeOutput, error)

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

See Subscribe 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 (*CodeStarNotifications) TagResource Uses

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

TagResource API operation for AWS CodeStar Notifications.

Associates a set of provided tags with a notification rule.

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 AWS CodeStar Notifications's API operation TagResource for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
AWS CodeStar Notifications can't find a resource that matches the provided
ARN.

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

* ErrCodeConcurrentModificationException "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.

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

func (*CodeStarNotifications) TagResourceRequest Uses

func (c *CodeStarNotifications) 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/codestar-notifications-2019-10-15/TagResource

func (*CodeStarNotifications) TagResourceWithContext Uses

func (c *CodeStarNotifications) 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 (*CodeStarNotifications) Unsubscribe Uses

func (c *CodeStarNotifications) Unsubscribe(input *UnsubscribeInput) (*UnsubscribeOutput, error)

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

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 AWS CodeStar Notifications's API operation Unsubscribe for usage and error information.

Returned Error Codes:

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

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

func (*CodeStarNotifications) UnsubscribeRequest Uses

func (c *CodeStarNotifications) UnsubscribeRequest(input *UnsubscribeInput) (req *request.Request, output *UnsubscribeOutput)

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

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

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

func (*CodeStarNotifications) UnsubscribeWithContext Uses

func (c *CodeStarNotifications) UnsubscribeWithContext(ctx aws.Context, input *UnsubscribeInput, opts ...request.Option) (*UnsubscribeOutput, error)

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

See Unsubscribe 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 (*CodeStarNotifications) UntagResource Uses

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

UntagResource API operation for AWS CodeStar Notifications.

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

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 AWS CodeStar Notifications's API operation UntagResource for usage and error information.

Returned Error Codes:

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
AWS CodeStar Notifications can't find a resource that matches the provided
ARN.

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

* ErrCodeConcurrentModificationException "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.

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

func (*CodeStarNotifications) UntagResourceRequest Uses

func (c *CodeStarNotifications) 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/codestar-notifications-2019-10-15/UntagResource

func (*CodeStarNotifications) UntagResourceWithContext Uses

func (c *CodeStarNotifications) 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 (*CodeStarNotifications) UpdateNotificationRule Uses

func (c *CodeStarNotifications) UpdateNotificationRule(input *UpdateNotificationRuleInput) (*UpdateNotificationRuleOutput, error)

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

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 AWS CodeStar Notifications's API operation UpdateNotificationRule for usage and error information.

Returned Error Codes:

* ErrCodeValidationException "ValidationException"
One or more parameter values are not valid.

* ErrCodeResourceNotFoundException "ResourceNotFoundException"
AWS CodeStar Notifications can't find a resource that matches the provided
ARN.

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

func (*CodeStarNotifications) UpdateNotificationRuleRequest Uses

func (c *CodeStarNotifications) UpdateNotificationRuleRequest(input *UpdateNotificationRuleInput) (req *request.Request, output *UpdateNotificationRuleOutput)

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

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

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

func (*CodeStarNotifications) UpdateNotificationRuleWithContext Uses

func (c *CodeStarNotifications) UpdateNotificationRuleWithContext(ctx aws.Context, input *UpdateNotificationRuleInput, opts ...request.Option) (*UpdateNotificationRuleOutput, error)

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

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

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

type CreateNotificationRuleInput Uses

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 *string `type:"string" required:"true" enum:"DetailType"`

    // 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 *string `type:"string" enum:"NotificationRuleStatus"`

    // 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) GoString Uses

func (s CreateNotificationRuleInput) GoString() string

GoString returns the string representation

func (*CreateNotificationRuleInput) SetClientRequestToken Uses

func (s *CreateNotificationRuleInput) SetClientRequestToken(v string) *CreateNotificationRuleInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateNotificationRuleInput) SetDetailType Uses

func (s *CreateNotificationRuleInput) SetDetailType(v string) *CreateNotificationRuleInput

SetDetailType sets the DetailType field's value.

func (*CreateNotificationRuleInput) SetEventTypeIds Uses

func (s *CreateNotificationRuleInput) SetEventTypeIds(v []*string) *CreateNotificationRuleInput

SetEventTypeIds sets the EventTypeIds field's value.

func (*CreateNotificationRuleInput) SetName Uses

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

SetName sets the Name field's value.

func (*CreateNotificationRuleInput) SetResource Uses

func (s *CreateNotificationRuleInput) SetResource(v string) *CreateNotificationRuleInput

SetResource sets the Resource field's value.

func (*CreateNotificationRuleInput) SetStatus Uses

func (s *CreateNotificationRuleInput) SetStatus(v string) *CreateNotificationRuleInput

SetStatus sets the Status field's value.

func (*CreateNotificationRuleInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (*CreateNotificationRuleInput) SetTargets Uses

func (s *CreateNotificationRuleInput) SetTargets(v []*Target) *CreateNotificationRuleInput

SetTargets sets the Targets field's value.

func (CreateNotificationRuleInput) String Uses

func (s CreateNotificationRuleInput) String() string

String returns the string representation

func (*CreateNotificationRuleInput) Validate Uses

func (s *CreateNotificationRuleInput) Validate() error

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

type CreateNotificationRuleOutput Uses

type CreateNotificationRuleOutput struct {

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

func (CreateNotificationRuleOutput) GoString Uses

func (s CreateNotificationRuleOutput) GoString() string

GoString returns the string representation

func (*CreateNotificationRuleOutput) SetArn Uses

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

SetArn sets the Arn field's value.

func (CreateNotificationRuleOutput) String Uses

func (s CreateNotificationRuleOutput) String() string

String returns the string representation

type DeleteNotificationRuleInput Uses

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) GoString Uses

func (s DeleteNotificationRuleInput) GoString() string

GoString returns the string representation

func (*DeleteNotificationRuleInput) SetArn Uses

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

SetArn sets the Arn field's value.

func (DeleteNotificationRuleInput) String Uses

func (s DeleteNotificationRuleInput) String() string

String returns the string representation

func (*DeleteNotificationRuleInput) Validate Uses

func (s *DeleteNotificationRuleInput) Validate() error

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

type DeleteNotificationRuleOutput Uses

type DeleteNotificationRuleOutput struct {

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

func (DeleteNotificationRuleOutput) GoString Uses

func (s DeleteNotificationRuleOutput) GoString() string

GoString returns the string representation

func (*DeleteNotificationRuleOutput) SetArn Uses

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

SetArn sets the Arn field's value.

func (DeleteNotificationRuleOutput) String Uses

func (s DeleteNotificationRuleOutput) String() string

String returns the string representation

type DeleteTargetInput Uses

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) GoString Uses

func (s DeleteTargetInput) GoString() string

GoString returns the string representation

func (*DeleteTargetInput) SetForceUnsubscribeAll Uses

func (s *DeleteTargetInput) SetForceUnsubscribeAll(v bool) *DeleteTargetInput

SetForceUnsubscribeAll sets the ForceUnsubscribeAll field's value.

func (*DeleteTargetInput) SetTargetAddress Uses

func (s *DeleteTargetInput) SetTargetAddress(v string) *DeleteTargetInput

SetTargetAddress sets the TargetAddress field's value.

func (DeleteTargetInput) String Uses

func (s DeleteTargetInput) String() string

String returns the string representation

func (*DeleteTargetInput) Validate Uses

func (s *DeleteTargetInput) Validate() error

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

type DeleteTargetOutput Uses

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

func (DeleteTargetOutput) GoString Uses

func (s DeleteTargetOutput) GoString() string

GoString returns the string representation

func (DeleteTargetOutput) String Uses

func (s DeleteTargetOutput) String() string

String returns the string representation

type DescribeNotificationRuleInput Uses

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) GoString Uses

func (s DescribeNotificationRuleInput) GoString() string

GoString returns the string representation

func (*DescribeNotificationRuleInput) SetArn Uses

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

SetArn sets the Arn field's value.

func (DescribeNotificationRuleInput) String Uses

func (s DescribeNotificationRuleInput) String() string

String returns the string representation

func (*DescribeNotificationRuleInput) Validate Uses

func (s *DescribeNotificationRuleInput) Validate() error

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

type DescribeNotificationRuleOutput Uses

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 *string `type:"string" enum:"DetailType"`

    // 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 *string `type:"string" enum:"NotificationRuleStatus"`

    // 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) GoString Uses

func (s DescribeNotificationRuleOutput) GoString() string

GoString returns the string representation

func (*DescribeNotificationRuleOutput) SetArn Uses

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

SetArn sets the Arn field's value.

func (*DescribeNotificationRuleOutput) SetCreatedBy Uses

func (s *DescribeNotificationRuleOutput) SetCreatedBy(v string) *DescribeNotificationRuleOutput

SetCreatedBy sets the CreatedBy field's value.

func (*DescribeNotificationRuleOutput) SetCreatedTimestamp Uses

func (s *DescribeNotificationRuleOutput) SetCreatedTimestamp(v time.Time) *DescribeNotificationRuleOutput

SetCreatedTimestamp sets the CreatedTimestamp field's value.

func (*DescribeNotificationRuleOutput) SetDetailType Uses

func (s *DescribeNotificationRuleOutput) SetDetailType(v string) *DescribeNotificationRuleOutput

SetDetailType sets the DetailType field's value.

func (*DescribeNotificationRuleOutput) SetEventTypes Uses

func (s *DescribeNotificationRuleOutput) SetEventTypes(v []*EventTypeSummary) *DescribeNotificationRuleOutput

SetEventTypes sets the EventTypes field's value.

func (*DescribeNotificationRuleOutput) SetLastModifiedTimestamp Uses

func (s *DescribeNotificationRuleOutput) SetLastModifiedTimestamp(v time.Time) *DescribeNotificationRuleOutput

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (*DescribeNotificationRuleOutput) SetName Uses

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

SetName sets the Name field's value.

func (*DescribeNotificationRuleOutput) SetResource Uses

func (s *DescribeNotificationRuleOutput) SetResource(v string) *DescribeNotificationRuleOutput

SetResource sets the Resource field's value.

func (*DescribeNotificationRuleOutput) SetStatus Uses

func (s *DescribeNotificationRuleOutput) SetStatus(v string) *DescribeNotificationRuleOutput

SetStatus sets the Status field's value.

func (*DescribeNotificationRuleOutput) SetTags Uses

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

SetTags sets the Tags field's value.

func (*DescribeNotificationRuleOutput) SetTargets Uses

func (s *DescribeNotificationRuleOutput) SetTargets(v []*TargetSummary) *DescribeNotificationRuleOutput

SetTargets sets the Targets field's value.

func (DescribeNotificationRuleOutput) String Uses

func (s DescribeNotificationRuleOutput) String() string

String returns the string representation

type EventTypeSummary Uses

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) GoString Uses

func (s EventTypeSummary) GoString() string

GoString returns the string representation

func (*EventTypeSummary) SetEventTypeId Uses

func (s *EventTypeSummary) SetEventTypeId(v string) *EventTypeSummary

SetEventTypeId sets the EventTypeId field's value.

func (*EventTypeSummary) SetEventTypeName Uses

func (s *EventTypeSummary) SetEventTypeName(v string) *EventTypeSummary

SetEventTypeName sets the EventTypeName field's value.

func (*EventTypeSummary) SetResourceType Uses

func (s *EventTypeSummary) SetResourceType(v string) *EventTypeSummary

SetResourceType sets the ResourceType field's value.

func (*EventTypeSummary) SetServiceName Uses

func (s *EventTypeSummary) SetServiceName(v string) *EventTypeSummary

SetServiceName sets the ServiceName field's value.

func (EventTypeSummary) String Uses

func (s EventTypeSummary) String() string

String returns the string representation

type ListEventTypesFilter Uses

type ListEventTypesFilter struct {

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

    // 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) GoString Uses

func (s ListEventTypesFilter) GoString() string

GoString returns the string representation

func (*ListEventTypesFilter) SetName Uses

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

SetName sets the Name field's value.

func (*ListEventTypesFilter) SetValue Uses

func (s *ListEventTypesFilter) SetValue(v string) *ListEventTypesFilter

SetValue sets the Value field's value.

func (ListEventTypesFilter) String Uses

func (s ListEventTypesFilter) String() string

String returns the string representation

func (*ListEventTypesFilter) Validate Uses

func (s *ListEventTypesFilter) Validate() error

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

type ListEventTypesInput Uses

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) GoString Uses

func (s ListEventTypesInput) GoString() string

GoString returns the string representation

func (*ListEventTypesInput) SetFilters Uses

func (s *ListEventTypesInput) SetFilters(v []*ListEventTypesFilter) *ListEventTypesInput

SetFilters sets the Filters field's value.

func (*ListEventTypesInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListEventTypesInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListEventTypesInput) String Uses

func (s ListEventTypesInput) String() string

String returns the string representation

func (*ListEventTypesInput) Validate Uses

func (s *ListEventTypesInput) Validate() error

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

type ListEventTypesOutput Uses

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) GoString Uses

func (s ListEventTypesOutput) GoString() string

GoString returns the string representation

func (*ListEventTypesOutput) SetEventTypes Uses

func (s *ListEventTypesOutput) SetEventTypes(v []*EventTypeSummary) *ListEventTypesOutput

SetEventTypes sets the EventTypes field's value.

func (*ListEventTypesOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListEventTypesOutput) String Uses

func (s ListEventTypesOutput) String() string

String returns the string representation

type ListNotificationRulesFilter Uses

type ListNotificationRulesFilter struct {

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

    // 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) GoString Uses

func (s ListNotificationRulesFilter) GoString() string

GoString returns the string representation

func (*ListNotificationRulesFilter) SetName Uses

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

SetName sets the Name field's value.

func (*ListNotificationRulesFilter) SetValue Uses

func (s *ListNotificationRulesFilter) SetValue(v string) *ListNotificationRulesFilter

SetValue sets the Value field's value.

func (ListNotificationRulesFilter) String Uses

func (s ListNotificationRulesFilter) String() string

String returns the string representation

func (*ListNotificationRulesFilter) Validate Uses

func (s *ListNotificationRulesFilter) Validate() error

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

type ListNotificationRulesInput Uses

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) GoString Uses

func (s ListNotificationRulesInput) GoString() string

GoString returns the string representation

func (*ListNotificationRulesInput) SetFilters Uses

func (s *ListNotificationRulesInput) SetFilters(v []*ListNotificationRulesFilter) *ListNotificationRulesInput

SetFilters sets the Filters field's value.

func (*ListNotificationRulesInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListNotificationRulesInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListNotificationRulesInput) String Uses

func (s ListNotificationRulesInput) String() string

String returns the string representation

func (*ListNotificationRulesInput) Validate Uses

func (s *ListNotificationRulesInput) Validate() error

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

type ListNotificationRulesOutput Uses

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) GoString Uses

func (s ListNotificationRulesOutput) GoString() string

GoString returns the string representation

func (*ListNotificationRulesOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListNotificationRulesOutput) SetNotificationRules Uses

func (s *ListNotificationRulesOutput) SetNotificationRules(v []*NotificationRuleSummary) *ListNotificationRulesOutput

SetNotificationRules sets the NotificationRules field's value.

func (ListNotificationRulesOutput) String Uses

func (s ListNotificationRulesOutput) String() string

String returns the string representation

type ListTagsForResourceInput Uses

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) GoString Uses

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetArn Uses

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

SetArn sets the Arn field's value.

func (ListTagsForResourceInput) String Uses

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate Uses

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput Uses

type ListTagsForResourceOutput struct {

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

func (ListTagsForResourceOutput) GoString Uses

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags Uses

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String Uses

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTargetsFilter Uses

type ListTargetsFilter struct {

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

    // 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) GoString Uses

func (s ListTargetsFilter) GoString() string

GoString returns the string representation

func (*ListTargetsFilter) SetName Uses

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

SetName sets the Name field's value.

func (*ListTargetsFilter) SetValue Uses

func (s *ListTargetsFilter) SetValue(v string) *ListTargetsFilter

SetValue sets the Value field's value.

func (ListTargetsFilter) String Uses

func (s ListTargetsFilter) String() string

String returns the string representation

func (*ListTargetsFilter) Validate Uses

func (s *ListTargetsFilter) Validate() error

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

type ListTargetsInput Uses

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) GoString Uses

func (s ListTargetsInput) GoString() string

GoString returns the string representation

func (*ListTargetsInput) SetFilters Uses

func (s *ListTargetsInput) SetFilters(v []*ListTargetsFilter) *ListTargetsInput

SetFilters sets the Filters field's value.

func (*ListTargetsInput) SetMaxResults Uses

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

SetMaxResults sets the MaxResults field's value.

func (*ListTargetsInput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (ListTargetsInput) String Uses

func (s ListTargetsInput) String() string

String returns the string representation

func (*ListTargetsInput) Validate Uses

func (s *ListTargetsInput) Validate() error

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

type ListTargetsOutput Uses

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) GoString Uses

func (s ListTargetsOutput) GoString() string

GoString returns the string representation

func (*ListTargetsOutput) SetNextToken Uses

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

SetNextToken sets the NextToken field's value.

func (*ListTargetsOutput) SetTargets Uses

func (s *ListTargetsOutput) SetTargets(v []*TargetSummary) *ListTargetsOutput

SetTargets sets the Targets field's value.

func (ListTargetsOutput) String Uses

func (s ListTargetsOutput) String() string

String returns the string representation

type NotificationRuleSummary Uses

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) GoString Uses

func (s NotificationRuleSummary) GoString() string

GoString returns the string representation

func (*NotificationRuleSummary) SetArn Uses

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

SetArn sets the Arn field's value.

func (*NotificationRuleSummary) SetId Uses

func (s *NotificationRuleSummary) SetId(v string) *NotificationRuleSummary

SetId sets the Id field's value.

func (NotificationRuleSummary) String Uses

func (s NotificationRuleSummary) String() string

String returns the string representation

type SubscribeInput Uses

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) GoString Uses

func (s SubscribeInput) GoString() string

GoString returns the string representation

func (*SubscribeInput) SetArn Uses

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

SetArn sets the Arn field's value.

func (*SubscribeInput) SetClientRequestToken Uses

func (s *SubscribeInput) SetClientRequestToken(v string) *SubscribeInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*SubscribeInput) SetTarget Uses

func (s *SubscribeInput) SetTarget(v *Target) *SubscribeInput

SetTarget sets the Target field's value.

func (SubscribeInput) String Uses

func (s SubscribeInput) String() string

String returns the string representation

func (*SubscribeInput) Validate Uses

func (s *SubscribeInput) Validate() error

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

type SubscribeOutput Uses

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) GoString Uses

func (s SubscribeOutput) GoString() string

GoString returns the string representation

func (*SubscribeOutput) SetArn Uses

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

SetArn sets the Arn field's value.

func (SubscribeOutput) String Uses

func (s SubscribeOutput) String() string

String returns the string representation

type TagResourceInput Uses

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) GoString Uses

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetArn Uses

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

SetArn sets the Arn field's value.

func (*TagResourceInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (TagResourceInput) String Uses

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate Uses

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput Uses

type TagResourceOutput struct {

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

func (TagResourceOutput) GoString Uses

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (*TagResourceOutput) SetTags Uses

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

SetTags sets the Tags field's value.

func (TagResourceOutput) String Uses

func (s TagResourceOutput) String() string

String returns the string representation

type Target Uses

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) GoString Uses

func (s Target) GoString() string

GoString returns the string representation

func (*Target) SetTargetAddress Uses

func (s *Target) SetTargetAddress(v string) *Target

SetTargetAddress sets the TargetAddress field's value.

func (*Target) SetTargetType Uses

func (s *Target) SetTargetType(v string) *Target

SetTargetType sets the TargetType field's value.

func (Target) String Uses

func (s Target) String() string

String returns the string representation

func (*Target) Validate Uses

func (s *Target) Validate() error

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

type TargetSummary Uses

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 *string `type:"string" enum:"TargetStatus"`

    // 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) GoString Uses

func (s TargetSummary) GoString() string

GoString returns the string representation

func (*TargetSummary) SetTargetAddress Uses

func (s *TargetSummary) SetTargetAddress(v string) *TargetSummary

SetTargetAddress sets the TargetAddress field's value.

func (*TargetSummary) SetTargetStatus Uses

func (s *TargetSummary) SetTargetStatus(v string) *TargetSummary

SetTargetStatus sets the TargetStatus field's value.

func (*TargetSummary) SetTargetType Uses

func (s *TargetSummary) SetTargetType(v string) *TargetSummary

SetTargetType sets the TargetType field's value.

func (TargetSummary) String Uses

func (s TargetSummary) String() string

String returns the string representation

type UnsubscribeInput Uses

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) GoString Uses

func (s UnsubscribeInput) GoString() string

GoString returns the string representation

func (*UnsubscribeInput) SetArn Uses

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

SetArn sets the Arn field's value.

func (*UnsubscribeInput) SetTargetAddress Uses

func (s *UnsubscribeInput) SetTargetAddress(v string) *UnsubscribeInput

SetTargetAddress sets the TargetAddress field's value.

func (UnsubscribeInput) String Uses

func (s UnsubscribeInput) String() string

String returns the string representation

func (*UnsubscribeInput) Validate Uses

func (s *UnsubscribeInput) Validate() error

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

type UnsubscribeOutput Uses

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) GoString Uses

func (s UnsubscribeOutput) GoString() string

GoString returns the string representation

func (*UnsubscribeOutput) SetArn Uses

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

SetArn sets the Arn field's value.

func (UnsubscribeOutput) String Uses

func (s UnsubscribeOutput) String() string

String returns the string representation

type UntagResourceInput Uses

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) GoString Uses

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetArn Uses

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

SetArn sets the Arn field's value.

func (*UntagResourceInput) SetTagKeys Uses

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String Uses

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate Uses

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput Uses

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

func (UntagResourceOutput) GoString Uses

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String Uses

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateNotificationRuleInput Uses

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 *string `type:"string" enum:"DetailType"`

    // 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 *string `type:"string" enum:"NotificationRuleStatus"`

    // 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) GoString Uses

func (s UpdateNotificationRuleInput) GoString() string

GoString returns the string representation

func (*UpdateNotificationRuleInput) SetArn Uses

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

SetArn sets the Arn field's value.

func (*UpdateNotificationRuleInput) SetDetailType Uses

func (s *UpdateNotificationRuleInput) SetDetailType(v string) *UpdateNotificationRuleInput

SetDetailType sets the DetailType field's value.

func (*UpdateNotificationRuleInput) SetEventTypeIds Uses

func (s *UpdateNotificationRuleInput) SetEventTypeIds(v []*string) *UpdateNotificationRuleInput

SetEventTypeIds sets the EventTypeIds field's value.

func (*UpdateNotificationRuleInput) SetName Uses

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

SetName sets the Name field's value.

func (*UpdateNotificationRuleInput) SetStatus Uses

func (s *UpdateNotificationRuleInput) SetStatus(v string) *UpdateNotificationRuleInput

SetStatus sets the Status field's value.

func (*UpdateNotificationRuleInput) SetTargets Uses

func (s *UpdateNotificationRuleInput) SetTargets(v []*Target) *UpdateNotificationRuleInput

SetTargets sets the Targets field's value.

func (UpdateNotificationRuleInput) String Uses

func (s UpdateNotificationRuleInput) String() string

String returns the string representation

func (*UpdateNotificationRuleInput) Validate Uses

func (s *UpdateNotificationRuleInput) Validate() error

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

type UpdateNotificationRuleOutput Uses

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

func (UpdateNotificationRuleOutput) GoString Uses

func (s UpdateNotificationRuleOutput) GoString() string

GoString returns the string representation

func (UpdateNotificationRuleOutput) String Uses

func (s UpdateNotificationRuleOutput) String() string

String returns the string representation

Directories

PathSynopsis
codestarnotificationsifacePackage codestarnotificationsiface provides an interface to enable mocking the AWS CodeStar Notifications service client for testing your code.

Package codestarnotifications imports 10 packages (graph) and is imported by 3 packages. Updated 2019-11-19. Refresh now. Tools for package owners.