iotfleethub

package
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Jul 4, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package iotfleethub provides the client and types for making API requests to AWS IoT Fleet Hub.

With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

See https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03 for more information on this service.

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

Using the Client

To contact AWS IoT Fleet Hub 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 IoT Fleet Hub client IoTFleetHub for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iotfleethub/#New

Index

Constants

View Source
const (
	// ApplicationStateCreating is a ApplicationState enum value
	ApplicationStateCreating = "CREATING"

	// ApplicationStateDeleting is a ApplicationState enum value
	ApplicationStateDeleting = "DELETING"

	// ApplicationStateActive is a ApplicationState enum value
	ApplicationStateActive = "ACTIVE"

	// ApplicationStateCreateFailed is a ApplicationState enum value
	ApplicationStateCreateFailed = "CREATE_FAILED"

	// ApplicationStateDeleteFailed is a ApplicationState enum value
	ApplicationStateDeleteFailed = "DELETE_FAILED"
)
View Source
const (

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The request conflicts with the current state of the resource.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// An unexpected error has occurred.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request is not valid.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// A limit has been exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The rate exceeds the limit.
	ErrCodeThrottlingException = "ThrottlingException"
)
View Source
const (
	ServiceName = "IoTFleetHub"      // Name of service.
	EndpointsID = "api.fleethub.iot" // ID to lookup a service endpoint with.
	ServiceID   = "IoTFleetHub"      // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ApplicationState_Values

func ApplicationState_Values() []string

ApplicationState_Values returns all elements of the ApplicationState enum

Types

type ApplicationSummary

type ApplicationSummary struct {

	// The date (in Unix epoch time) when the web application was created.
	ApplicationCreationDate *int64 `locationName:"applicationCreationDate" type:"long"`

	// An optional description of the web application.
	ApplicationDescription *string `locationName:"applicationDescription" min:"1" type:"string"`

	// The unique Id of the web application.
	//
	// ApplicationId is a required field
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The date (in Unix epoch time) when the web application was last updated.
	ApplicationLastUpdateDate *int64 `locationName:"applicationLastUpdateDate" type:"long"`

	// The name of the web application.
	//
	// ApplicationName is a required field
	ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`

	// The current state of the web application.
	ApplicationState *string `locationName:"applicationState" type:"string" enum:"ApplicationState"`

	// The URL of the web application.
	//
	// ApplicationUrl is a required field
	ApplicationUrl *string `locationName:"applicationUrl" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A summary of information about a AWS IoT Device Management web application.

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

func (ApplicationSummary) GoString

func (s ApplicationSummary) 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 (*ApplicationSummary) SetApplicationCreationDate

func (s *ApplicationSummary) SetApplicationCreationDate(v int64) *ApplicationSummary

SetApplicationCreationDate sets the ApplicationCreationDate field's value.

func (*ApplicationSummary) SetApplicationDescription

func (s *ApplicationSummary) SetApplicationDescription(v string) *ApplicationSummary

SetApplicationDescription sets the ApplicationDescription field's value.

func (*ApplicationSummary) SetApplicationId

func (s *ApplicationSummary) SetApplicationId(v string) *ApplicationSummary

SetApplicationId sets the ApplicationId field's value.

func (*ApplicationSummary) SetApplicationLastUpdateDate

func (s *ApplicationSummary) SetApplicationLastUpdateDate(v int64) *ApplicationSummary

SetApplicationLastUpdateDate sets the ApplicationLastUpdateDate field's value.

func (*ApplicationSummary) SetApplicationName

func (s *ApplicationSummary) SetApplicationName(v string) *ApplicationSummary

SetApplicationName sets the ApplicationName field's value.

func (*ApplicationSummary) SetApplicationState

func (s *ApplicationSummary) SetApplicationState(v string) *ApplicationSummary

SetApplicationState sets the ApplicationState field's value.

func (*ApplicationSummary) SetApplicationUrl

func (s *ApplicationSummary) SetApplicationUrl(v string) *ApplicationSummary

SetApplicationUrl sets the ApplicationUrl field's value.

func (ApplicationSummary) String

func (s ApplicationSummary) 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 ConflictException

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

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

The request conflicts with the current state of the resource.

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

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

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

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

type CreateApplicationInput

type CreateApplicationInput struct {

	// An optional description of the web application.
	ApplicationDescription *string `locationName:"applicationDescription" min:"1" type:"string"`

	// The name of the web application.
	//
	// ApplicationName is a required field
	ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The ARN of the role that the web application assumes when it interacts with
	// AWS IoT Core.
	//
	// The name of the role must be in the form AWSIotFleetHub_random_string .
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`

	// A set of key/value pairs that you can use to manage the web application resource.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateApplicationInput) GoString

func (s CreateApplicationInput) 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 (*CreateApplicationInput) SetApplicationDescription

func (s *CreateApplicationInput) SetApplicationDescription(v string) *CreateApplicationInput

SetApplicationDescription sets the ApplicationDescription field's value.

func (*CreateApplicationInput) SetApplicationName

func (s *CreateApplicationInput) SetApplicationName(v string) *CreateApplicationInput

SetApplicationName sets the ApplicationName field's value.

func (*CreateApplicationInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (*CreateApplicationInput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*CreateApplicationInput) SetTags

SetTags sets the Tags field's value.

func (CreateApplicationInput) String

func (s CreateApplicationInput) 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 (*CreateApplicationInput) Validate

func (s *CreateApplicationInput) Validate() error

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

type CreateApplicationOutput

type CreateApplicationOutput struct {

	// The ARN of the web application.
	//
	// ApplicationArn is a required field
	ApplicationArn *string `locationName:"applicationArn" min:"1" type:"string" required:"true"`

	// The unique Id of the web application.
	//
	// ApplicationId is a required field
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateApplicationOutput) GoString

func (s CreateApplicationOutput) 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 (*CreateApplicationOutput) SetApplicationArn

func (s *CreateApplicationOutput) SetApplicationArn(v string) *CreateApplicationOutput

SetApplicationArn sets the ApplicationArn field's value.

func (*CreateApplicationOutput) SetApplicationId

func (s *CreateApplicationOutput) SetApplicationId(v string) *CreateApplicationOutput

SetApplicationId sets the ApplicationId field's value.

func (CreateApplicationOutput) String

func (s CreateApplicationOutput) 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 DeleteApplicationInput

type DeleteApplicationInput struct {

	// The unique Id of the web application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (DeleteApplicationInput) GoString

func (s DeleteApplicationInput) 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 (*DeleteApplicationInput) SetApplicationId

func (s *DeleteApplicationInput) SetApplicationId(v string) *DeleteApplicationInput

SetApplicationId sets the ApplicationId field's value.

func (*DeleteApplicationInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (DeleteApplicationInput) String

func (s DeleteApplicationInput) 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 (*DeleteApplicationInput) Validate

func (s *DeleteApplicationInput) Validate() error

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

type DeleteApplicationOutput

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

func (DeleteApplicationOutput) GoString

func (s DeleteApplicationOutput) 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 (DeleteApplicationOutput) String

func (s DeleteApplicationOutput) 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 DescribeApplicationInput

type DescribeApplicationInput struct {

	// The unique Id of the web application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeApplicationInput) GoString

func (s DescribeApplicationInput) 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 (*DescribeApplicationInput) SetApplicationId

SetApplicationId sets the ApplicationId field's value.

func (DescribeApplicationInput) String

func (s DescribeApplicationInput) 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 (*DescribeApplicationInput) Validate

func (s *DescribeApplicationInput) Validate() error

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

type DescribeApplicationOutput

type DescribeApplicationOutput struct {

	// The ARN of the web application.
	//
	// ApplicationArn is a required field
	ApplicationArn *string `locationName:"applicationArn" min:"1" type:"string" required:"true"`

	// The date (in Unix epoch time) when the application was created.
	//
	// ApplicationCreationDate is a required field
	ApplicationCreationDate *int64 `locationName:"applicationCreationDate" type:"long" required:"true"`

	// An optional description of the web application.
	ApplicationDescription *string `locationName:"applicationDescription" min:"1" type:"string"`

	// The unique Id of the web application.
	//
	// ApplicationId is a required field
	ApplicationId *string `locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The date (in Unix epoch time) when the application was last updated.
	//
	// ApplicationLastUpdateDate is a required field
	ApplicationLastUpdateDate *int64 `locationName:"applicationLastUpdateDate" type:"long" required:"true"`

	// The name of the web application.
	//
	// ApplicationName is a required field
	ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`

	// The current state of the web application.
	//
	// ApplicationState is a required field
	ApplicationState *string `locationName:"applicationState" type:"string" required:"true" enum:"ApplicationState"`

	// The URL of the web application.
	//
	// ApplicationUrl is a required field
	ApplicationUrl *string `locationName:"applicationUrl" min:"1" type:"string" required:"true"`

	// A message indicating why the DescribeApplication API failed.
	ErrorMessage *string `locationName:"errorMessage" type:"string"`

	// The ARN of the role that the web application assumes when it interacts with
	// AWS IoT Core.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`

	// The Id of the single sign-on client that you use to authenticate and authorize
	// users on the web application.
	SsoClientId *string `locationName:"ssoClientId" type:"string"`

	// A set of key/value pairs that you can use to manage the web application resource.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (DescribeApplicationOutput) GoString

func (s DescribeApplicationOutput) 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 (*DescribeApplicationOutput) SetApplicationArn

SetApplicationArn sets the ApplicationArn field's value.

func (*DescribeApplicationOutput) SetApplicationCreationDate

func (s *DescribeApplicationOutput) SetApplicationCreationDate(v int64) *DescribeApplicationOutput

SetApplicationCreationDate sets the ApplicationCreationDate field's value.

func (*DescribeApplicationOutput) SetApplicationDescription

func (s *DescribeApplicationOutput) SetApplicationDescription(v string) *DescribeApplicationOutput

SetApplicationDescription sets the ApplicationDescription field's value.

func (*DescribeApplicationOutput) SetApplicationId

SetApplicationId sets the ApplicationId field's value.

func (*DescribeApplicationOutput) SetApplicationLastUpdateDate

func (s *DescribeApplicationOutput) SetApplicationLastUpdateDate(v int64) *DescribeApplicationOutput

SetApplicationLastUpdateDate sets the ApplicationLastUpdateDate field's value.

func (*DescribeApplicationOutput) SetApplicationName

SetApplicationName sets the ApplicationName field's value.

func (*DescribeApplicationOutput) SetApplicationState

func (s *DescribeApplicationOutput) SetApplicationState(v string) *DescribeApplicationOutput

SetApplicationState sets the ApplicationState field's value.

func (*DescribeApplicationOutput) SetApplicationUrl

SetApplicationUrl sets the ApplicationUrl field's value.

func (*DescribeApplicationOutput) SetErrorMessage

SetErrorMessage sets the ErrorMessage field's value.

func (*DescribeApplicationOutput) SetRoleArn

SetRoleArn sets the RoleArn field's value.

func (*DescribeApplicationOutput) SetSsoClientId

SetSsoClientId sets the SsoClientId field's value.

func (*DescribeApplicationOutput) SetTags

SetTags sets the Tags field's value.

func (DescribeApplicationOutput) String

func (s DescribeApplicationOutput) 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 InternalFailureException

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

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

An unexpected error has occurred.

func (*InternalFailureException) Code

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString

func (s InternalFailureException) 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 (*InternalFailureException) Message

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode

func (s *InternalFailureException) StatusCode() int

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

func (InternalFailureException) String

func (s InternalFailureException) 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 InvalidRequestException

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

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

The request is not valid.

func (*InvalidRequestException) Code

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString

func (s InvalidRequestException) 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 (*InvalidRequestException) Message

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode

func (s *InvalidRequestException) StatusCode() int

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

func (InvalidRequestException) String

func (s InvalidRequestException) 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 IoTFleetHub

type IoTFleetHub struct {
	*client.Client
}

IoTFleetHub provides the API operation methods for making requests to AWS IoT Fleet Hub. See this package's package overview docs for details on the service.

IoTFleetHub 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) *IoTFleetHub

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

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

func (*IoTFleetHub) CreateApplication

func (c *IoTFleetHub) CreateApplication(input *CreateApplicationInput) (*CreateApplicationOutput, error)

CreateApplication API operation for AWS IoT Fleet Hub.

Creates a Fleet Hub for AWS IoT Device Management web application.

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

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 IoT Fleet Hub's API operation CreateApplication for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • InternalFailureException An unexpected error has occurred.

  • ThrottlingException The rate exceeds the limit.

  • LimitExceededException A limit has been exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/CreateApplication

func (*IoTFleetHub) CreateApplicationRequest

func (c *IoTFleetHub) CreateApplicationRequest(input *CreateApplicationInput) (req *request.Request, output *CreateApplicationOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/CreateApplication

func (*IoTFleetHub) CreateApplicationWithContext

func (c *IoTFleetHub) CreateApplicationWithContext(ctx aws.Context, input *CreateApplicationInput, opts ...request.Option) (*CreateApplicationOutput, error)

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

See CreateApplication 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 (*IoTFleetHub) DeleteApplication

func (c *IoTFleetHub) DeleteApplication(input *DeleteApplicationInput) (*DeleteApplicationOutput, error)

DeleteApplication API operation for AWS IoT Fleet Hub.

Deletes a Fleet Hub for AWS IoT Device Management web application.

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

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 IoT Fleet Hub's API operation DeleteApplication for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • InternalFailureException An unexpected error has occurred.

  • ThrottlingException The rate exceeds the limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/DeleteApplication

func (*IoTFleetHub) DeleteApplicationRequest

func (c *IoTFleetHub) DeleteApplicationRequest(input *DeleteApplicationInput) (req *request.Request, output *DeleteApplicationOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/DeleteApplication

func (*IoTFleetHub) DeleteApplicationWithContext

func (c *IoTFleetHub) DeleteApplicationWithContext(ctx aws.Context, input *DeleteApplicationInput, opts ...request.Option) (*DeleteApplicationOutput, error)

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

See DeleteApplication 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 (*IoTFleetHub) DescribeApplication

func (c *IoTFleetHub) DescribeApplication(input *DescribeApplicationInput) (*DescribeApplicationOutput, error)

DescribeApplication API operation for AWS IoT Fleet Hub.

Gets information about a Fleet Hub for AWS IoT Device Management web application.

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

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 IoT Fleet Hub's API operation DescribeApplication for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • InternalFailureException An unexpected error has occurred.

  • ThrottlingException The rate exceeds the limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/DescribeApplication

func (*IoTFleetHub) DescribeApplicationRequest

func (c *IoTFleetHub) DescribeApplicationRequest(input *DescribeApplicationInput) (req *request.Request, output *DescribeApplicationOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/DescribeApplication

func (*IoTFleetHub) DescribeApplicationWithContext

func (c *IoTFleetHub) DescribeApplicationWithContext(ctx aws.Context, input *DescribeApplicationInput, opts ...request.Option) (*DescribeApplicationOutput, error)

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

See DescribeApplication 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 (*IoTFleetHub) ListApplications

func (c *IoTFleetHub) ListApplications(input *ListApplicationsInput) (*ListApplicationsOutput, error)

ListApplications API operation for AWS IoT Fleet Hub.

Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

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 IoT Fleet Hub's API operation ListApplications for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • InternalFailureException An unexpected error has occurred.

  • ThrottlingException The rate exceeds the limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/ListApplications

func (*IoTFleetHub) ListApplicationsPages

func (c *IoTFleetHub) ListApplicationsPages(input *ListApplicationsInput, fn func(*ListApplicationsOutput, bool) bool) error

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

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

func (*IoTFleetHub) ListApplicationsPagesWithContext

func (c *IoTFleetHub) ListApplicationsPagesWithContext(ctx aws.Context, input *ListApplicationsInput, fn func(*ListApplicationsOutput, bool) bool, opts ...request.Option) error

ListApplicationsPagesWithContext same as ListApplicationsPages 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 (*IoTFleetHub) ListApplicationsRequest

func (c *IoTFleetHub) ListApplicationsRequest(input *ListApplicationsInput) (req *request.Request, output *ListApplicationsOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/ListApplications

func (*IoTFleetHub) ListApplicationsWithContext

func (c *IoTFleetHub) ListApplicationsWithContext(ctx aws.Context, input *ListApplicationsInput, opts ...request.Option) (*ListApplicationsOutput, error)

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

See ListApplications 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 (*IoTFleetHub) ListTagsForResource

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

ListTagsForResource API operation for AWS IoT Fleet Hub.

Lists the tags for the specified resource.

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

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 IoT Fleet Hub's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/ListTagsForResource

func (*IoTFleetHub) ListTagsForResourceRequest

func (c *IoTFleetHub) 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/iotfleethub-2020-11-03/ListTagsForResource

func (*IoTFleetHub) ListTagsForResourceWithContext

func (c *IoTFleetHub) 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 (*IoTFleetHub) TagResource

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

TagResource API operation for AWS IoT Fleet Hub.

Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

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 IoT Fleet Hub's API operation TagResource for usage and error information.

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/TagResource

func (*IoTFleetHub) TagResourceRequest

func (c *IoTFleetHub) 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/iotfleethub-2020-11-03/TagResource

func (*IoTFleetHub) TagResourceWithContext

func (c *IoTFleetHub) 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 (*IoTFleetHub) UntagResource

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

UntagResource API operation for AWS IoT Fleet Hub.

Removes the specified tags (metadata) from the resource.

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

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 IoT Fleet Hub's API operation UntagResource for usage and error information.

Returned Error Types:

  • InternalFailureException An unexpected error has occurred.

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/UntagResource

func (*IoTFleetHub) UntagResourceRequest

func (c *IoTFleetHub) 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/iotfleethub-2020-11-03/UntagResource

func (*IoTFleetHub) UntagResourceWithContext

func (c *IoTFleetHub) 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 (*IoTFleetHub) UpdateApplication

func (c *IoTFleetHub) UpdateApplication(input *UpdateApplicationInput) (*UpdateApplicationOutput, error)

UpdateApplication API operation for AWS IoT Fleet Hub.

Updates information about a Fleet Hub for a AWS IoT Device Management web application.

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

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 IoT Fleet Hub's API operation UpdateApplication for usage and error information.

Returned Error Types:

  • InvalidRequestException The request is not valid.

  • ResourceNotFoundException The specified resource does not exist.

  • InternalFailureException An unexpected error has occurred.

  • ConflictException The request conflicts with the current state of the resource.

  • ThrottlingException The rate exceeds the limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/UpdateApplication

func (*IoTFleetHub) UpdateApplicationRequest

func (c *IoTFleetHub) UpdateApplicationRequest(input *UpdateApplicationInput) (req *request.Request, output *UpdateApplicationOutput)

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/iotfleethub-2020-11-03/UpdateApplication

func (*IoTFleetHub) UpdateApplicationWithContext

func (c *IoTFleetHub) UpdateApplicationWithContext(ctx aws.Context, input *UpdateApplicationInput, opts ...request.Option) (*UpdateApplicationOutput, error)

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

See UpdateApplication 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 LimitExceededException

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

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

A limit has been exceeded.

func (*LimitExceededException) Code

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString

func (s LimitExceededException) 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 (*LimitExceededException) Message

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode

func (s *LimitExceededException) StatusCode() int

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

func (LimitExceededException) String

func (s LimitExceededException) 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 ListApplicationsInput

type ListApplicationsInput struct {

	// A token used to get the next set of results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListApplicationsInput) GoString

func (s ListApplicationsInput) 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 (*ListApplicationsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListApplicationsInput) String

func (s ListApplicationsInput) 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 (*ListApplicationsInput) Validate

func (s *ListApplicationsInput) Validate() error

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

type ListApplicationsOutput

type ListApplicationsOutput struct {

	// An array of objects that provide summaries of information about the web applications
	// in the list.
	ApplicationSummaries []*ApplicationSummary `locationName:"applicationSummaries" type:"list"`

	// A token used to get the next set of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListApplicationsOutput) GoString

func (s ListApplicationsOutput) 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 (*ListApplicationsOutput) SetApplicationSummaries

func (s *ListApplicationsOutput) SetApplicationSummaries(v []*ApplicationSummary) *ListApplicationsOutput

SetApplicationSummaries sets the ApplicationSummaries field's value.

func (*ListApplicationsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListApplicationsOutput) String

func (s ListApplicationsOutput) String() string

String returns the string representation.

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

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

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

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

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

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The list of tags assigned to the resource.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

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

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

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

type ResourceNotFoundException

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

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

The specified resource does not exist.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

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

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

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

type TagResourceInput

type TagResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The new or modified tags for the resource.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

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

func (*TagResourceInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

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

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

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

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

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

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

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

type ThrottlingException

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

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

The rate exceeds the limit.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

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

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

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

type UntagResourceInput

type UntagResourceInput struct {

	// The ARN of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

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

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

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

func (*UntagResourceInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

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

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

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

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

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

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

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

type UpdateApplicationInput

type UpdateApplicationInput struct {

	// An optional description of the web application.
	ApplicationDescription *string `locationName:"applicationDescription" min:"1" type:"string"`

	// The unique Id of the web application.
	//
	// ApplicationId is a required field
	ApplicationId *string `location:"uri" locationName:"applicationId" min:"36" type:"string" required:"true"`

	// The name of the web application.
	ApplicationName *string `locationName:"applicationName" min:"1" type:"string"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (UpdateApplicationInput) GoString

func (s UpdateApplicationInput) 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 (*UpdateApplicationInput) SetApplicationDescription

func (s *UpdateApplicationInput) SetApplicationDescription(v string) *UpdateApplicationInput

SetApplicationDescription sets the ApplicationDescription field's value.

func (*UpdateApplicationInput) SetApplicationId

func (s *UpdateApplicationInput) SetApplicationId(v string) *UpdateApplicationInput

SetApplicationId sets the ApplicationId field's value.

func (*UpdateApplicationInput) SetApplicationName

func (s *UpdateApplicationInput) SetApplicationName(v string) *UpdateApplicationInput

SetApplicationName sets the ApplicationName field's value.

func (*UpdateApplicationInput) SetClientToken

SetClientToken sets the ClientToken field's value.

func (UpdateApplicationInput) String

func (s UpdateApplicationInput) 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 (*UpdateApplicationInput) Validate

func (s *UpdateApplicationInput) Validate() error

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

type UpdateApplicationOutput

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

func (UpdateApplicationOutput) GoString

func (s UpdateApplicationOutput) 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 (UpdateApplicationOutput) String

func (s UpdateApplicationOutput) String() string

String returns the string representation.

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

Directories

Path Synopsis
Package iotfleethubiface provides an interface to enable mocking the AWS IoT Fleet Hub service client for testing your code.
Package iotfleethubiface provides an interface to enable mocking the AWS IoT Fleet Hub service client for testing your code.

Jump to

Keyboard shortcuts

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