sks

package
v0.4.0 Latest Latest
Warning

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

Go to latest
Published: Apr 15, 2024 License: Apache-2.0 Imports: 9 Imported by: 2

Documentation

Index

Constants

View Source
const (
	ServiceName = "sks"       // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "sks"       // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Sks

type Sks struct {
	*client.Client
}

Sks provides the API operation methods for making requests to sks. See this package's package overview docs for details on the service.

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

func ExtraNew

func ExtraNew(info *utils.UrlInfo, p client.ConfigProvider, cfgs ...*aws.Config) *Sks

extraNew create int can support ssl or region locate set

func New

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

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

Example:

// Create a Sks client from just a session.
svc := sks.New(mySession)

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

func SdkNew

func SdkNew(p client.ConfigProvider, cfgs *ksc.Config, info ...*utils.UrlInfo) *Sks

SdkNew create int can support ssl or region locate set

func (*Sks) CreateKey

func (c *Sks) CreateKey(input *map[string]interface{}) (*map[string]interface{}, error)

CreateKey API operation for sks.

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 KSC API reference guide for sks's API operation CreateKey for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sks-2015-11-01/CreateKey

func (*Sks) CreateKeyRequest

func (c *Sks) CreateKeyRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/sks-2015-11-01/CreateKey

func (*Sks) CreateKeyWithContext

func (c *Sks) CreateKeyWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

See CreateKey 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 (*Sks) DeleteKey

func (c *Sks) DeleteKey(input *map[string]interface{}) (*map[string]interface{}, error)

DeleteKey API operation for sks.

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 KSC API reference guide for sks's API operation DeleteKey for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sks-2015-11-01/DeleteKey

func (*Sks) DeleteKeyRequest

func (c *Sks) DeleteKeyRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/sks-2015-11-01/DeleteKey

func (*Sks) DeleteKeyWithContext

func (c *Sks) DeleteKeyWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

See DeleteKey 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 (*Sks) DescribeKeys

func (c *Sks) DescribeKeys(input *map[string]interface{}) (*map[string]interface{}, error)

DescribeKeys API operation for sks.

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 KSC API reference guide for sks's API operation DescribeKeys for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sks-2015-11-01/DescribeKeys

func (*Sks) DescribeKeysRequest

func (c *Sks) DescribeKeysRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/sks-2015-11-01/DescribeKeys

func (*Sks) DescribeKeysWithContext

func (c *Sks) DescribeKeysWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

See DescribeKeys 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 (*Sks) ImportKey

func (c *Sks) ImportKey(input *map[string]interface{}) (*map[string]interface{}, error)

ImportKey API operation for sks.

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 KSC API reference guide for sks's API operation ImportKey for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sks-2015-11-01/ImportKey

func (*Sks) ImportKeyRequest

func (c *Sks) ImportKeyRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/sks-2015-11-01/ImportKey

func (*Sks) ImportKeyWithContext

func (c *Sks) ImportKeyWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

See ImportKey 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 (*Sks) ModifyKey

func (c *Sks) ModifyKey(input *map[string]interface{}) (*map[string]interface{}, error)

ModifyKey API operation for sks.

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 KSC API reference guide for sks's API operation ModifyKey for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/sks-2015-11-01/ModifyKey

func (*Sks) ModifyKeyRequest

func (c *Sks) ModifyKeyRequest(input *map[string]interface{}) (req *request.Request, output *map[string]interface{})

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/sks-2015-11-01/ModifyKey

func (*Sks) ModifyKeyWithContext

func (c *Sks) ModifyKeyWithContext(ctx aws.Context, input *map[string]interface{}, opts ...request.Option) (*map[string]interface{}, error)

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

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

Directories

Path Synopsis
Package sksiface provides an interface to enable mocking the sks service client for testing your code.
Package sksiface provides an interface to enable mocking the sks service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL