controlcatalog

package
v0.0.0-...-b4884ed Latest Latest
Warning

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

 Go to latest Published: Dec 13, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package controlcatalog provides the client and types for making API requests to AWS Control Catalog.

Welcome to the Amazon Web Services Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by Amazon Web Services Control Catalog.

Use the following links to get started with the Amazon Web Services Control Catalog API:

See https://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10 for more information on this service.

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

Using the Client

To contact AWS Control Catalog 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 Control Catalog client ControlCatalog for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/controlcatalog/#New

Index

Constants

View Source 
const (

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

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An internal service error occurred during the processing of your request.
	// Try again later.
	ErrCodeInternalServerException = "InternalServerException"

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

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The request has invalid or missing parameters.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "ControlCatalog" // Name of service.
	EndpointsID = "controlcatalog" // ID to lookup a service endpoint with.
	ServiceID   = "ControlCatalog" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

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

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

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

type AssociatedDomainSummary 

type AssociatedDomainSummary struct {

	// The Amazon Resource Name (ARN) of the related domain.
	Arn *string `min:"33" type:"string"`

	// The name of the related domain.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

A summary of the domain that a common control or an objective belongs to.

func (AssociatedDomainSummary) GoString 

func (s AssociatedDomainSummary) GoString() string

GoString returns the string representation.

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

func (*AssociatedDomainSummary) SetArn 

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

SetArn sets the Arn field's value.

func (*AssociatedDomainSummary) SetName 

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

SetName sets the Name field's value.

func (AssociatedDomainSummary) String 

func (s AssociatedDomainSummary) String() string

String returns the string representation.

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

type AssociatedObjectiveSummary 

type AssociatedObjectiveSummary struct {

	// The Amazon Resource Name (ARN) of the related objective.
	Arn *string `min:"36" type:"string"`

	// The name of the related objective.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

A summary of the objective that a common control supports.

func (AssociatedObjectiveSummary) GoString 

func (s AssociatedObjectiveSummary) GoString() string

GoString returns the string representation.

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

func (*AssociatedObjectiveSummary) SetArn 

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

SetArn sets the Arn field's value.

func (*AssociatedObjectiveSummary) SetName 

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

SetName sets the Name field's value.

func (AssociatedObjectiveSummary) String 

func (s AssociatedObjectiveSummary) String() string

String returns the string representation.

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

type CommonControlFilter 

type CommonControlFilter struct {

	// The objective that's used as filter criteria.
	//
	// You can use this parameter to specify one objective ARN at a time. Passing
	// multiple ARNs in the CommonControlFilter isn’t currently supported.
	Objectives []*ObjectiveResourceFilter `type:"list"`
	// contains filtered or unexported fields
}

An optional filter that narrows the results to a specific objective.

func (CommonControlFilter) GoString 

func (s CommonControlFilter) GoString() string

GoString returns the string representation.

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

func (*CommonControlFilter) SetObjectives 

func (s *CommonControlFilter) SetObjectives(v []*ObjectiveResourceFilter) *CommonControlFilter

SetObjectives sets the Objectives field's value.

func (CommonControlFilter) String 

func (s CommonControlFilter) String() string

String returns the string representation.

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

func (*CommonControlFilter) Validate 

func (s *CommonControlFilter) Validate() error

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

type CommonControlSummary 

type CommonControlSummary struct {

	// The Amazon Resource Name (ARN) that identifies the common control.
	//
	// Arn is a required field
	Arn *string `min:"41" type:"string" required:"true"`

	// The time when the common control was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" required:"true"`

	// The description of the common control.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// The domain that the common control belongs to.
	//
	// Domain is a required field
	Domain *AssociatedDomainSummary `type:"structure" required:"true"`

	// The time when the common control was most recently updated.
	//
	// LastUpdateTime is a required field
	LastUpdateTime *time.Time `type:"timestamp" required:"true"`

	// The name of the common control.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The objective that the common control belongs to.
	//
	// Objective is a required field
	Objective *AssociatedObjectiveSummary `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A summary of metadata for a common control.

func (CommonControlSummary) GoString 

func (s CommonControlSummary) GoString() string

GoString returns the string representation.

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

func (*CommonControlSummary) SetArn 

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

SetArn sets the Arn field's value.

func (*CommonControlSummary) SetCreateTime 

func (s *CommonControlSummary) SetCreateTime(v time.Time) *CommonControlSummary

SetCreateTime sets the CreateTime field's value.

func (*CommonControlSummary) SetDescription 

func (s *CommonControlSummary) SetDescription(v string) *CommonControlSummary

SetDescription sets the Description field's value.

func (*CommonControlSummary) SetDomain 

func (s *CommonControlSummary) SetDomain(v *AssociatedDomainSummary) *CommonControlSummary

SetDomain sets the Domain field's value.

func (*CommonControlSummary) SetLastUpdateTime 

func (s *CommonControlSummary) SetLastUpdateTime(v time.Time) *CommonControlSummary

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*CommonControlSummary) SetName 

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

SetName sets the Name field's value.

func (*CommonControlSummary) SetObjective 

func (s *CommonControlSummary) SetObjective(v *AssociatedObjectiveSummary) *CommonControlSummary

SetObjective sets the Objective field's value.

func (CommonControlSummary) String 

func (s CommonControlSummary) String() string

String returns the string representation.

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

type ControlCatalog 

type ControlCatalog struct {
	*client.Client
}

ControlCatalog provides the API operation methods for making requests to AWS Control Catalog. See this package's package overview docs for details on the service.

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

func New 

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

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

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

func (*ControlCatalog) ListCommonControls 

func (c *ControlCatalog) ListCommonControls(input *ListCommonControlsInput) (*ListCommonControlsOutput, error)

ListCommonControls API operation for AWS Control Catalog.

Returns a paginated list of common controls from the Amazon Web Services Control Catalog.

You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.

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 Control Catalog's API operation ListCommonControls for usage and error information.

Returned Error Types:

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

  • InternalServerException An internal service error occurred during the processing of your request. Try again later.

  • ValidationException The request has invalid or missing parameters.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10/ListCommonControls

func (*ControlCatalog) ListCommonControlsPages 

func (c *ControlCatalog) ListCommonControlsPages(input *ListCommonControlsInput, fn func(*ListCommonControlsOutput, bool) bool) error

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

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

func (*ControlCatalog) ListCommonControlsPagesWithContext 

func (c *ControlCatalog) ListCommonControlsPagesWithContext(ctx aws.Context, input *ListCommonControlsInput, fn func(*ListCommonControlsOutput, bool) bool, opts ...request.Option) error

ListCommonControlsPagesWithContext same as ListCommonControlsPages 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 (*ControlCatalog) ListCommonControlsRequest 

func (c *ControlCatalog) ListCommonControlsRequest(input *ListCommonControlsInput) (req *request.Request, output *ListCommonControlsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10/ListCommonControls

func (*ControlCatalog) ListCommonControlsWithContext 

func (c *ControlCatalog) ListCommonControlsWithContext(ctx aws.Context, input *ListCommonControlsInput, opts ...request.Option) (*ListCommonControlsOutput, error)

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

See ListCommonControls 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 (*ControlCatalog) ListDomains 

func (c *ControlCatalog) ListDomains(input *ListDomainsInput) (*ListDomainsOutput, error)

ListDomains API operation for AWS Control Catalog.

Returns a paginated list of domains from the Amazon Web Services Control Catalog.

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 Control Catalog's API operation ListDomains for usage and error information.

Returned Error Types:

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

  • InternalServerException An internal service error occurred during the processing of your request. Try again later.

  • ValidationException The request has invalid or missing parameters.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10/ListDomains

func (*ControlCatalog) ListDomainsPages 

func (c *ControlCatalog) ListDomainsPages(input *ListDomainsInput, fn func(*ListDomainsOutput, bool) bool) error

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

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

func (*ControlCatalog) ListDomainsPagesWithContext 

func (c *ControlCatalog) ListDomainsPagesWithContext(ctx aws.Context, input *ListDomainsInput, fn func(*ListDomainsOutput, bool) bool, opts ...request.Option) error

ListDomainsPagesWithContext same as ListDomainsPages 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 (*ControlCatalog) ListDomainsRequest 

func (c *ControlCatalog) ListDomainsRequest(input *ListDomainsInput) (req *request.Request, output *ListDomainsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10/ListDomains

func (*ControlCatalog) ListDomainsWithContext 

func (c *ControlCatalog) ListDomainsWithContext(ctx aws.Context, input *ListDomainsInput, opts ...request.Option) (*ListDomainsOutput, error)

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

See ListDomains 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 (*ControlCatalog) ListObjectives 

func (c *ControlCatalog) ListObjectives(input *ListObjectivesInput) (*ListObjectivesOutput, error)

ListObjectives API operation for AWS Control Catalog.

Returns a paginated list of objectives from the Amazon Web Services Control Catalog.

You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.

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 Control Catalog's API operation ListObjectives for usage and error information.

Returned Error Types:

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

  • InternalServerException An internal service error occurred during the processing of your request. Try again later.

  • ValidationException The request has invalid or missing parameters.

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10/ListObjectives

func (*ControlCatalog) ListObjectivesPages 

func (c *ControlCatalog) ListObjectivesPages(input *ListObjectivesInput, fn func(*ListObjectivesOutput, bool) bool) error

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

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

func (*ControlCatalog) ListObjectivesPagesWithContext 

func (c *ControlCatalog) ListObjectivesPagesWithContext(ctx aws.Context, input *ListObjectivesInput, fn func(*ListObjectivesOutput, bool) bool, opts ...request.Option) error

ListObjectivesPagesWithContext same as ListObjectivesPages 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 (*ControlCatalog) ListObjectivesRequest 

func (c *ControlCatalog) ListObjectivesRequest(input *ListObjectivesInput) (req *request.Request, output *ListObjectivesOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/controlcatalog-2018-05-10/ListObjectives

func (*ControlCatalog) ListObjectivesWithContext 

func (c *ControlCatalog) ListObjectivesWithContext(ctx aws.Context, input *ListObjectivesInput, opts ...request.Option) (*ListObjectivesOutput, error)

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

See ListObjectives 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 DomainResourceFilter 

type DomainResourceFilter struct {

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

The domain resource that's being used as a filter.

func (DomainResourceFilter) GoString 

func (s DomainResourceFilter) GoString() string

GoString returns the string representation.

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

func (*DomainResourceFilter) SetArn 

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

SetArn sets the Arn field's value.

func (DomainResourceFilter) String 

func (s DomainResourceFilter) String() string

String returns the string representation.

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

func (*DomainResourceFilter) Validate 

func (s *DomainResourceFilter) Validate() error

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

type DomainSummary 

type DomainSummary struct {

	// The Amazon Resource Name (ARN) that identifies the domain.
	//
	// Arn is a required field
	Arn *string `min:"33" type:"string" required:"true"`

	// The time when the domain was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" required:"true"`

	// The description of the domain.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// The time when the domain was most recently updated.
	//
	// LastUpdateTime is a required field
	LastUpdateTime *time.Time `type:"timestamp" required:"true"`

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

A summary of metadata for a domain.

func (DomainSummary) GoString 

func (s DomainSummary) GoString() string

GoString returns the string representation.

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

func (*DomainSummary) SetArn 

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

SetArn sets the Arn field's value.

func (*DomainSummary) SetCreateTime 

func (s *DomainSummary) SetCreateTime(v time.Time) *DomainSummary

SetCreateTime sets the CreateTime field's value.

func (*DomainSummary) SetDescription 

func (s *DomainSummary) SetDescription(v string) *DomainSummary

SetDescription sets the Description field's value.

func (*DomainSummary) SetLastUpdateTime 

func (s *DomainSummary) SetLastUpdateTime(v time.Time) *DomainSummary

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*DomainSummary) SetName 

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

SetName sets the Name field's value.

func (DomainSummary) String 

func (s DomainSummary) String() string

String returns the string representation.

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

type InternalServerException 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

An internal service error occurred during the processing of your request. Try again later.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

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

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

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

type ListCommonControlsInput 

type ListCommonControlsInput struct {

	// An optional filter that narrows the results to a specific objective.
	//
	// This filter allows you to specify one objective ARN at a time. Passing multiple
	// ARNs in the CommonControlFilter isn’t currently supported.
	CommonControlFilter *CommonControlFilter `type:"structure"`

	// The maximum number of results on a page or for an API request call.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The pagination token that's used to fetch the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListCommonControlsInput) GoString 

func (s ListCommonControlsInput) GoString() string

GoString returns the string representation.

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

func (*ListCommonControlsInput) SetCommonControlFilter 

func (s *ListCommonControlsInput) SetCommonControlFilter(v *CommonControlFilter) *ListCommonControlsInput

SetCommonControlFilter sets the CommonControlFilter field's value.

func (*ListCommonControlsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListCommonControlsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListCommonControlsInput) String 

func (s ListCommonControlsInput) String() string

String returns the string representation.

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

func (*ListCommonControlsInput) Validate 

func (s *ListCommonControlsInput) Validate() error

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

type ListCommonControlsOutput 

type ListCommonControlsOutput struct {

	// The list of common controls that the ListCommonControls API returns.
	//
	// CommonControls is a required field
	CommonControls []*CommonControlSummary `type:"list" required:"true"`

	// The pagination token that's used to fetch the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCommonControlsOutput) GoString 

func (s ListCommonControlsOutput) GoString() string

GoString returns the string representation.

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

func (*ListCommonControlsOutput) SetCommonControls 

func (s *ListCommonControlsOutput) SetCommonControls(v []*CommonControlSummary) *ListCommonControlsOutput

SetCommonControls sets the CommonControls field's value.

func (*ListCommonControlsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListCommonControlsOutput) String 

func (s ListCommonControlsOutput) String() string

String returns the string representation.

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

type ListDomainsInput 

type ListDomainsInput struct {

	// The maximum number of results on a page or for an API request call.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The pagination token that's used to fetch the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListDomainsInput) GoString 

func (s ListDomainsInput) GoString() string

GoString returns the string representation.

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

func (*ListDomainsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDomainsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDomainsInput) String 

func (s ListDomainsInput) String() string

String returns the string representation.

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

func (*ListDomainsInput) Validate 

func (s *ListDomainsInput) Validate() error

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

type ListDomainsOutput 

type ListDomainsOutput struct {

	// The list of domains that the ListDomains API returns.
	//
	// Domains is a required field
	Domains []*DomainSummary `type:"list" required:"true"`

	// The pagination token that's used to fetch the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDomainsOutput) GoString 

func (s ListDomainsOutput) GoString() string

GoString returns the string representation.

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

func (*ListDomainsOutput) SetDomains 

func (s *ListDomainsOutput) SetDomains(v []*DomainSummary) *ListDomainsOutput

SetDomains sets the Domains field's value.

func (*ListDomainsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDomainsOutput) String 

func (s ListDomainsOutput) String() string

String returns the string representation.

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

type ListObjectivesInput 

type ListObjectivesInput struct {

	// The maximum number of results on a page or for an API request call.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The pagination token that's used to fetch the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// An optional filter that narrows the results to a specific domain.
	//
	// This filter allows you to specify one domain ARN at a time. Passing multiple
	// ARNs in the ObjectiveFilter isn’t currently supported.
	ObjectiveFilter *ObjectiveFilter `type:"structure"`
	// contains filtered or unexported fields
}

func (ListObjectivesInput) GoString 

func (s ListObjectivesInput) GoString() string

GoString returns the string representation.

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

func (*ListObjectivesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListObjectivesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListObjectivesInput) SetObjectiveFilter 

func (s *ListObjectivesInput) SetObjectiveFilter(v *ObjectiveFilter) *ListObjectivesInput

SetObjectiveFilter sets the ObjectiveFilter field's value.

func (ListObjectivesInput) String 

func (s ListObjectivesInput) String() string

String returns the string representation.

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

func (*ListObjectivesInput) Validate 

func (s *ListObjectivesInput) Validate() error

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

type ListObjectivesOutput 

type ListObjectivesOutput struct {

	// The pagination token that's used to fetch the next set of results.
	NextToken *string `type:"string"`

	// The list of objectives that the ListObjectives API returns.
	//
	// Objectives is a required field
	Objectives []*ObjectiveSummary `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListObjectivesOutput) GoString 

func (s ListObjectivesOutput) GoString() string

GoString returns the string representation.

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

func (*ListObjectivesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListObjectivesOutput) SetObjectives 

func (s *ListObjectivesOutput) SetObjectives(v []*ObjectiveSummary) *ListObjectivesOutput

SetObjectives sets the Objectives field's value.

func (ListObjectivesOutput) String 

func (s ListObjectivesOutput) String() string

String returns the string representation.

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

type ObjectiveFilter 

type ObjectiveFilter struct {

	// The domain that's used as filter criteria.
	//
	// You can use this parameter to specify one domain ARN at a time. Passing multiple
	// ARNs in the ObjectiveFilter isn’t currently supported.
	Domains []*DomainResourceFilter `type:"list"`
	// contains filtered or unexported fields
}

An optional filter that narrows the list of objectives to a specific domain.

func (ObjectiveFilter) GoString 

func (s ObjectiveFilter) GoString() string

GoString returns the string representation.

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

func (*ObjectiveFilter) SetDomains 

func (s *ObjectiveFilter) SetDomains(v []*DomainResourceFilter) *ObjectiveFilter

SetDomains sets the Domains field's value.

func (ObjectiveFilter) String 

func (s ObjectiveFilter) String() string

String returns the string representation.

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

func (*ObjectiveFilter) Validate 

func (s *ObjectiveFilter) Validate() error

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

type ObjectiveResourceFilter 

type ObjectiveResourceFilter struct {

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

The objective resource that's being used as a filter.

func (ObjectiveResourceFilter) GoString 

func (s ObjectiveResourceFilter) GoString() string

GoString returns the string representation.

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

func (*ObjectiveResourceFilter) SetArn 

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

SetArn sets the Arn field's value.

func (ObjectiveResourceFilter) String 

func (s ObjectiveResourceFilter) String() string

String returns the string representation.

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

func (*ObjectiveResourceFilter) Validate 

func (s *ObjectiveResourceFilter) Validate() error

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

type ObjectiveSummary 

type ObjectiveSummary struct {

	// The Amazon Resource Name (ARN) that identifies the objective.
	//
	// Arn is a required field
	Arn *string `min:"36" type:"string" required:"true"`

	// The time when the objective was created.
	//
	// CreateTime is a required field
	CreateTime *time.Time `type:"timestamp" required:"true"`

	// The description of the objective.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// The domain that the objective belongs to.
	//
	// Domain is a required field
	Domain *AssociatedDomainSummary `type:"structure" required:"true"`

	// The time when the objective was most recently updated.
	//
	// LastUpdateTime is a required field
	LastUpdateTime *time.Time `type:"timestamp" required:"true"`

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

A summary of metadata for an objective.

func (ObjectiveSummary) GoString 

func (s ObjectiveSummary) GoString() string

GoString returns the string representation.

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

func (*ObjectiveSummary) SetArn 

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

SetArn sets the Arn field's value.

func (*ObjectiveSummary) SetCreateTime 

func (s *ObjectiveSummary) SetCreateTime(v time.Time) *ObjectiveSummary

SetCreateTime sets the CreateTime field's value.

func (*ObjectiveSummary) SetDescription 

func (s *ObjectiveSummary) SetDescription(v string) *ObjectiveSummary

SetDescription sets the Description field's value.

func (*ObjectiveSummary) SetDomain 

func (s *ObjectiveSummary) SetDomain(v *AssociatedDomainSummary) *ObjectiveSummary

SetDomain sets the Domain field's value.

func (*ObjectiveSummary) SetLastUpdateTime 

func (s *ObjectiveSummary) SetLastUpdateTime(v time.Time) *ObjectiveSummary

SetLastUpdateTime sets the LastUpdateTime field's value.

func (*ObjectiveSummary) SetName 

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

SetName sets the Name field's value.

func (ObjectiveSummary) String 

func (s ObjectiveSummary) String() string

String returns the string representation.

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

type ThrottlingException 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

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

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

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

type ValidationException 

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

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The request has invalid or missing parameters.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

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

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

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

Source Files

View all Source files

Directories

Path Synopsis
Package controlcatalogiface provides an interface to enable mocking the AWS Control Catalog service client for testing your code.
 Package controlcatalogiface provides an interface to enable mocking the AWS Control Catalog service client for testing your code.

Jump to

Keyboard shortcuts

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