Documentation ¶
Overview ¶
Package iot1clickprojects provides the client and types for making API requests to AWS IoT 1-Click Projects Service.
The AWS IoT 1-Click Projects API Reference ¶
See https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14 for more information on this service.
See iot1clickprojects package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/iot1clickprojects/
Using the Client ¶
To contact AWS IoT 1-Click Projects Service 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 1-Click Projects Service client IoT1ClickProjects for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iot1clickprojects/#New
Index ¶
- Constants
- type AssociateDeviceWithPlacementInput
- func (s AssociateDeviceWithPlacementInput) GoString() string
- func (s *AssociateDeviceWithPlacementInput) SetDeviceId(v string) *AssociateDeviceWithPlacementInput
- func (s *AssociateDeviceWithPlacementInput) SetDeviceTemplateName(v string) *AssociateDeviceWithPlacementInput
- func (s *AssociateDeviceWithPlacementInput) SetPlacementName(v string) *AssociateDeviceWithPlacementInput
- func (s *AssociateDeviceWithPlacementInput) SetProjectName(v string) *AssociateDeviceWithPlacementInput
- func (s AssociateDeviceWithPlacementInput) String() string
- func (s *AssociateDeviceWithPlacementInput) Validate() error
- type AssociateDeviceWithPlacementOutput
- type CreatePlacementInput
- func (s CreatePlacementInput) GoString() string
- func (s *CreatePlacementInput) SetAttributes(v map[string]*string) *CreatePlacementInput
- func (s *CreatePlacementInput) SetPlacementName(v string) *CreatePlacementInput
- func (s *CreatePlacementInput) SetProjectName(v string) *CreatePlacementInput
- func (s CreatePlacementInput) String() string
- func (s *CreatePlacementInput) Validate() error
- type CreatePlacementOutput
- type CreateProjectInput
- func (s CreateProjectInput) GoString() string
- func (s *CreateProjectInput) SetDescription(v string) *CreateProjectInput
- func (s *CreateProjectInput) SetPlacementTemplate(v *PlacementTemplate) *CreateProjectInput
- func (s *CreateProjectInput) SetProjectName(v string) *CreateProjectInput
- func (s *CreateProjectInput) SetTags(v map[string]*string) *CreateProjectInput
- func (s CreateProjectInput) String() string
- func (s *CreateProjectInput) Validate() error
- type CreateProjectOutput
- type DeletePlacementInput
- type DeletePlacementOutput
- type DeleteProjectInput
- type DeleteProjectOutput
- type DescribePlacementInput
- func (s DescribePlacementInput) GoString() string
- func (s *DescribePlacementInput) SetPlacementName(v string) *DescribePlacementInput
- func (s *DescribePlacementInput) SetProjectName(v string) *DescribePlacementInput
- func (s DescribePlacementInput) String() string
- func (s *DescribePlacementInput) Validate() error
- type DescribePlacementOutput
- type DescribeProjectInput
- type DescribeProjectOutput
- type DeviceTemplate
- type DisassociateDeviceFromPlacementInput
- func (s DisassociateDeviceFromPlacementInput) GoString() string
- func (s *DisassociateDeviceFromPlacementInput) SetDeviceTemplateName(v string) *DisassociateDeviceFromPlacementInput
- func (s *DisassociateDeviceFromPlacementInput) SetPlacementName(v string) *DisassociateDeviceFromPlacementInput
- func (s *DisassociateDeviceFromPlacementInput) SetProjectName(v string) *DisassociateDeviceFromPlacementInput
- func (s DisassociateDeviceFromPlacementInput) String() string
- func (s *DisassociateDeviceFromPlacementInput) Validate() error
- type DisassociateDeviceFromPlacementOutput
- type GetDevicesInPlacementInput
- func (s GetDevicesInPlacementInput) GoString() string
- func (s *GetDevicesInPlacementInput) SetPlacementName(v string) *GetDevicesInPlacementInput
- func (s *GetDevicesInPlacementInput) SetProjectName(v string) *GetDevicesInPlacementInput
- func (s GetDevicesInPlacementInput) String() string
- func (s *GetDevicesInPlacementInput) Validate() error
- type GetDevicesInPlacementOutput
- type InternalFailureException
- func (s *InternalFailureException) Code() string
- func (s *InternalFailureException) Error() string
- func (s InternalFailureException) GoString() string
- func (s *InternalFailureException) Message() string
- func (s *InternalFailureException) OrigErr() error
- func (s *InternalFailureException) RequestID() string
- func (s *InternalFailureException) StatusCode() int
- func (s InternalFailureException) String() string
- type InvalidRequestException
- func (s *InvalidRequestException) Code() string
- func (s *InvalidRequestException) Error() string
- func (s InvalidRequestException) GoString() string
- func (s *InvalidRequestException) Message() string
- func (s *InvalidRequestException) OrigErr() error
- func (s *InvalidRequestException) RequestID() string
- func (s *InvalidRequestException) StatusCode() int
- func (s InvalidRequestException) String() string
- type IoT1ClickProjects
- func (c *IoT1ClickProjects) AssociateDeviceWithPlacement(input *AssociateDeviceWithPlacementInput) (*AssociateDeviceWithPlacementOutput, error)
- func (c *IoT1ClickProjects) AssociateDeviceWithPlacementRequest(input *AssociateDeviceWithPlacementInput) (req *request.Request, output *AssociateDeviceWithPlacementOutput)
- func (c *IoT1ClickProjects) AssociateDeviceWithPlacementWithContext(ctx aws.Context, input *AssociateDeviceWithPlacementInput, ...) (*AssociateDeviceWithPlacementOutput, error)
- func (c *IoT1ClickProjects) CreatePlacement(input *CreatePlacementInput) (*CreatePlacementOutput, error)
- func (c *IoT1ClickProjects) CreatePlacementRequest(input *CreatePlacementInput) (req *request.Request, output *CreatePlacementOutput)
- func (c *IoT1ClickProjects) CreatePlacementWithContext(ctx aws.Context, input *CreatePlacementInput, opts ...request.Option) (*CreatePlacementOutput, error)
- func (c *IoT1ClickProjects) CreateProject(input *CreateProjectInput) (*CreateProjectOutput, error)
- func (c *IoT1ClickProjects) CreateProjectRequest(input *CreateProjectInput) (req *request.Request, output *CreateProjectOutput)
- func (c *IoT1ClickProjects) CreateProjectWithContext(ctx aws.Context, input *CreateProjectInput, opts ...request.Option) (*CreateProjectOutput, error)
- func (c *IoT1ClickProjects) DeletePlacement(input *DeletePlacementInput) (*DeletePlacementOutput, error)
- func (c *IoT1ClickProjects) DeletePlacementRequest(input *DeletePlacementInput) (req *request.Request, output *DeletePlacementOutput)
- func (c *IoT1ClickProjects) DeletePlacementWithContext(ctx aws.Context, input *DeletePlacementInput, opts ...request.Option) (*DeletePlacementOutput, error)
- func (c *IoT1ClickProjects) DeleteProject(input *DeleteProjectInput) (*DeleteProjectOutput, error)
- func (c *IoT1ClickProjects) DeleteProjectRequest(input *DeleteProjectInput) (req *request.Request, output *DeleteProjectOutput)
- func (c *IoT1ClickProjects) DeleteProjectWithContext(ctx aws.Context, input *DeleteProjectInput, opts ...request.Option) (*DeleteProjectOutput, error)
- func (c *IoT1ClickProjects) DescribePlacement(input *DescribePlacementInput) (*DescribePlacementOutput, error)
- func (c *IoT1ClickProjects) DescribePlacementRequest(input *DescribePlacementInput) (req *request.Request, output *DescribePlacementOutput)
- func (c *IoT1ClickProjects) DescribePlacementWithContext(ctx aws.Context, input *DescribePlacementInput, opts ...request.Option) (*DescribePlacementOutput, error)
- func (c *IoT1ClickProjects) DescribeProject(input *DescribeProjectInput) (*DescribeProjectOutput, error)
- func (c *IoT1ClickProjects) DescribeProjectRequest(input *DescribeProjectInput) (req *request.Request, output *DescribeProjectOutput)
- func (c *IoT1ClickProjects) DescribeProjectWithContext(ctx aws.Context, input *DescribeProjectInput, opts ...request.Option) (*DescribeProjectOutput, error)
- func (c *IoT1ClickProjects) DisassociateDeviceFromPlacement(input *DisassociateDeviceFromPlacementInput) (*DisassociateDeviceFromPlacementOutput, error)
- func (c *IoT1ClickProjects) DisassociateDeviceFromPlacementRequest(input *DisassociateDeviceFromPlacementInput) (req *request.Request, output *DisassociateDeviceFromPlacementOutput)
- func (c *IoT1ClickProjects) DisassociateDeviceFromPlacementWithContext(ctx aws.Context, input *DisassociateDeviceFromPlacementInput, ...) (*DisassociateDeviceFromPlacementOutput, error)
- func (c *IoT1ClickProjects) GetDevicesInPlacement(input *GetDevicesInPlacementInput) (*GetDevicesInPlacementOutput, error)
- func (c *IoT1ClickProjects) GetDevicesInPlacementRequest(input *GetDevicesInPlacementInput) (req *request.Request, output *GetDevicesInPlacementOutput)
- func (c *IoT1ClickProjects) GetDevicesInPlacementWithContext(ctx aws.Context, input *GetDevicesInPlacementInput, opts ...request.Option) (*GetDevicesInPlacementOutput, error)
- func (c *IoT1ClickProjects) ListPlacements(input *ListPlacementsInput) (*ListPlacementsOutput, error)
- func (c *IoT1ClickProjects) ListPlacementsPages(input *ListPlacementsInput, fn func(*ListPlacementsOutput, bool) bool) error
- func (c *IoT1ClickProjects) ListPlacementsPagesWithContext(ctx aws.Context, input *ListPlacementsInput, ...) error
- func (c *IoT1ClickProjects) ListPlacementsRequest(input *ListPlacementsInput) (req *request.Request, output *ListPlacementsOutput)
- func (c *IoT1ClickProjects) ListPlacementsWithContext(ctx aws.Context, input *ListPlacementsInput, opts ...request.Option) (*ListPlacementsOutput, error)
- func (c *IoT1ClickProjects) ListProjects(input *ListProjectsInput) (*ListProjectsOutput, error)
- func (c *IoT1ClickProjects) ListProjectsPages(input *ListProjectsInput, fn func(*ListProjectsOutput, bool) bool) error
- func (c *IoT1ClickProjects) ListProjectsPagesWithContext(ctx aws.Context, input *ListProjectsInput, ...) error
- func (c *IoT1ClickProjects) ListProjectsRequest(input *ListProjectsInput) (req *request.Request, output *ListProjectsOutput)
- func (c *IoT1ClickProjects) ListProjectsWithContext(ctx aws.Context, input *ListProjectsInput, opts ...request.Option) (*ListProjectsOutput, error)
- func (c *IoT1ClickProjects) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
- func (c *IoT1ClickProjects) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
- func (c *IoT1ClickProjects) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
- func (c *IoT1ClickProjects) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
- func (c *IoT1ClickProjects) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
- func (c *IoT1ClickProjects) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
- func (c *IoT1ClickProjects) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
- func (c *IoT1ClickProjects) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
- func (c *IoT1ClickProjects) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
- func (c *IoT1ClickProjects) UpdatePlacement(input *UpdatePlacementInput) (*UpdatePlacementOutput, error)
- func (c *IoT1ClickProjects) UpdatePlacementRequest(input *UpdatePlacementInput) (req *request.Request, output *UpdatePlacementOutput)
- func (c *IoT1ClickProjects) UpdatePlacementWithContext(ctx aws.Context, input *UpdatePlacementInput, opts ...request.Option) (*UpdatePlacementOutput, error)
- func (c *IoT1ClickProjects) UpdateProject(input *UpdateProjectInput) (*UpdateProjectOutput, error)
- func (c *IoT1ClickProjects) UpdateProjectRequest(input *UpdateProjectInput) (req *request.Request, output *UpdateProjectOutput)
- func (c *IoT1ClickProjects) UpdateProjectWithContext(ctx aws.Context, input *UpdateProjectInput, opts ...request.Option) (*UpdateProjectOutput, error)
- type ListPlacementsInput
- func (s ListPlacementsInput) GoString() string
- func (s *ListPlacementsInput) SetMaxResults(v int64) *ListPlacementsInput
- func (s *ListPlacementsInput) SetNextToken(v string) *ListPlacementsInput
- func (s *ListPlacementsInput) SetProjectName(v string) *ListPlacementsInput
- func (s ListPlacementsInput) String() string
- func (s *ListPlacementsInput) Validate() error
- type ListPlacementsOutput
- type ListProjectsInput
- type ListProjectsOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type PlacementDescription
- func (s PlacementDescription) GoString() string
- func (s *PlacementDescription) SetAttributes(v map[string]*string) *PlacementDescription
- func (s *PlacementDescription) SetCreatedDate(v time.Time) *PlacementDescription
- func (s *PlacementDescription) SetPlacementName(v string) *PlacementDescription
- func (s *PlacementDescription) SetProjectName(v string) *PlacementDescription
- func (s *PlacementDescription) SetUpdatedDate(v time.Time) *PlacementDescription
- func (s PlacementDescription) String() string
- type PlacementSummary
- func (s PlacementSummary) GoString() string
- func (s *PlacementSummary) SetCreatedDate(v time.Time) *PlacementSummary
- func (s *PlacementSummary) SetPlacementName(v string) *PlacementSummary
- func (s *PlacementSummary) SetProjectName(v string) *PlacementSummary
- func (s *PlacementSummary) SetUpdatedDate(v time.Time) *PlacementSummary
- func (s PlacementSummary) String() string
- type PlacementTemplate
- type ProjectDescription
- func (s ProjectDescription) GoString() string
- func (s *ProjectDescription) SetArn(v string) *ProjectDescription
- func (s *ProjectDescription) SetCreatedDate(v time.Time) *ProjectDescription
- func (s *ProjectDescription) SetDescription(v string) *ProjectDescription
- func (s *ProjectDescription) SetPlacementTemplate(v *PlacementTemplate) *ProjectDescription
- func (s *ProjectDescription) SetProjectName(v string) *ProjectDescription
- func (s *ProjectDescription) SetTags(v map[string]*string) *ProjectDescription
- func (s *ProjectDescription) SetUpdatedDate(v time.Time) *ProjectDescription
- func (s ProjectDescription) String() string
- type ProjectSummary
- func (s ProjectSummary) GoString() string
- func (s *ProjectSummary) SetArn(v string) *ProjectSummary
- func (s *ProjectSummary) SetCreatedDate(v time.Time) *ProjectSummary
- func (s *ProjectSummary) SetProjectName(v string) *ProjectSummary
- func (s *ProjectSummary) SetTags(v map[string]*string) *ProjectSummary
- func (s *ProjectSummary) SetUpdatedDate(v time.Time) *ProjectSummary
- func (s ProjectSummary) String() string
- type ResourceConflictException
- func (s *ResourceConflictException) Code() string
- func (s *ResourceConflictException) Error() string
- func (s ResourceConflictException) GoString() string
- func (s *ResourceConflictException) Message() string
- func (s *ResourceConflictException) OrigErr() error
- func (s *ResourceConflictException) RequestID() string
- func (s *ResourceConflictException) StatusCode() int
- func (s ResourceConflictException) String() string
- type ResourceNotFoundException
- func (s *ResourceNotFoundException) Code() string
- func (s *ResourceNotFoundException) Error() string
- func (s ResourceNotFoundException) GoString() string
- func (s *ResourceNotFoundException) Message() string
- func (s *ResourceNotFoundException) OrigErr() error
- func (s *ResourceNotFoundException) RequestID() string
- func (s *ResourceNotFoundException) StatusCode() int
- func (s ResourceNotFoundException) String() string
- type TagResourceInput
- type TagResourceOutput
- type TooManyRequestsException
- func (s *TooManyRequestsException) Code() string
- func (s *TooManyRequestsException) Error() string
- func (s TooManyRequestsException) GoString() string
- func (s *TooManyRequestsException) Message() string
- func (s *TooManyRequestsException) OrigErr() error
- func (s *TooManyRequestsException) RequestID() string
- func (s *TooManyRequestsException) StatusCode() int
- func (s TooManyRequestsException) String() string
- type UntagResourceInput
- type UntagResourceOutput
- type UpdatePlacementInput
- func (s UpdatePlacementInput) GoString() string
- func (s *UpdatePlacementInput) SetAttributes(v map[string]*string) *UpdatePlacementInput
- func (s *UpdatePlacementInput) SetPlacementName(v string) *UpdatePlacementInput
- func (s *UpdatePlacementInput) SetProjectName(v string) *UpdatePlacementInput
- func (s UpdatePlacementInput) String() string
- func (s *UpdatePlacementInput) Validate() error
- type UpdatePlacementOutput
- type UpdateProjectInput
- func (s UpdateProjectInput) GoString() string
- func (s *UpdateProjectInput) SetDescription(v string) *UpdateProjectInput
- func (s *UpdateProjectInput) SetPlacementTemplate(v *PlacementTemplate) *UpdateProjectInput
- func (s *UpdateProjectInput) SetProjectName(v string) *UpdateProjectInput
- func (s UpdateProjectInput) String() string
- func (s *UpdateProjectInput) Validate() error
- type UpdateProjectOutput
Constants ¶
const ( // ErrCodeInternalFailureException for service response error code // "InternalFailureException". ErrCodeInternalFailureException = "InternalFailureException" // ErrCodeInvalidRequestException for service response error code // "InvalidRequestException". ErrCodeInvalidRequestException = "InvalidRequestException" // ErrCodeResourceConflictException for service response error code // "ResourceConflictException". ErrCodeResourceConflictException = "ResourceConflictException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeTooManyRequestsException for service response error code // "TooManyRequestsException". ErrCodeTooManyRequestsException = "TooManyRequestsException" )
const ( ServiceName = "projects.iot1click" // Name of service. EndpointsID = ServiceName // ID to lookup a service endpoint with. ServiceID = "IoT 1Click Projects" // ServiceID is a unique identifier of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AssociateDeviceWithPlacementInput ¶
type AssociateDeviceWithPlacementInput struct { // The ID of the physical device to be associated with the given placement in // the project. Note that a mandatory 4 character prefix is required for all // deviceId values. // // DeviceId is a required field DeviceId *string `locationName:"deviceId" min:"1" type:"string" required:"true"` // The device template name to associate with the device ID. // // DeviceTemplateName is a required field DeviceTemplateName *string `location:"uri" locationName:"deviceTemplateName" min:"1" type:"string" required:"true"` // The name of the placement in which to associate the device. // // PlacementName is a required field PlacementName *string `location:"uri" locationName:"placementName" min:"1" type:"string" required:"true"` // The name of the project containing the placement in which to associate the // device. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (AssociateDeviceWithPlacementInput) GoString ¶
func (s AssociateDeviceWithPlacementInput) 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 (*AssociateDeviceWithPlacementInput) SetDeviceId ¶
func (s *AssociateDeviceWithPlacementInput) SetDeviceId(v string) *AssociateDeviceWithPlacementInput
SetDeviceId sets the DeviceId field's value.
func (*AssociateDeviceWithPlacementInput) SetDeviceTemplateName ¶
func (s *AssociateDeviceWithPlacementInput) SetDeviceTemplateName(v string) *AssociateDeviceWithPlacementInput
SetDeviceTemplateName sets the DeviceTemplateName field's value.
func (*AssociateDeviceWithPlacementInput) SetPlacementName ¶
func (s *AssociateDeviceWithPlacementInput) SetPlacementName(v string) *AssociateDeviceWithPlacementInput
SetPlacementName sets the PlacementName field's value.
func (*AssociateDeviceWithPlacementInput) SetProjectName ¶
func (s *AssociateDeviceWithPlacementInput) SetProjectName(v string) *AssociateDeviceWithPlacementInput
SetProjectName sets the ProjectName field's value.
func (AssociateDeviceWithPlacementInput) String ¶
func (s AssociateDeviceWithPlacementInput) 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 (*AssociateDeviceWithPlacementInput) Validate ¶
func (s *AssociateDeviceWithPlacementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AssociateDeviceWithPlacementOutput ¶
type AssociateDeviceWithPlacementOutput struct {
// contains filtered or unexported fields
}
func (AssociateDeviceWithPlacementOutput) GoString ¶
func (s AssociateDeviceWithPlacementOutput) 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 (AssociateDeviceWithPlacementOutput) String ¶
func (s AssociateDeviceWithPlacementOutput) 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 CreatePlacementInput ¶
type CreatePlacementInput struct { // Optional user-defined key/value pairs providing contextual data (such as // location or function) for the placement. Attributes map[string]*string `locationName:"attributes" type:"map"` // The name of the placement to be created. // // PlacementName is a required field PlacementName *string `locationName:"placementName" min:"1" type:"string" required:"true"` // The name of the project in which to create the placement. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (CreatePlacementInput) GoString ¶
func (s CreatePlacementInput) 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 (*CreatePlacementInput) SetAttributes ¶
func (s *CreatePlacementInput) SetAttributes(v map[string]*string) *CreatePlacementInput
SetAttributes sets the Attributes field's value.
func (*CreatePlacementInput) SetPlacementName ¶
func (s *CreatePlacementInput) SetPlacementName(v string) *CreatePlacementInput
SetPlacementName sets the PlacementName field's value.
func (*CreatePlacementInput) SetProjectName ¶
func (s *CreatePlacementInput) SetProjectName(v string) *CreatePlacementInput
SetProjectName sets the ProjectName field's value.
func (CreatePlacementInput) String ¶
func (s CreatePlacementInput) 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 (*CreatePlacementInput) Validate ¶
func (s *CreatePlacementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreatePlacementOutput ¶
type CreatePlacementOutput struct {
// contains filtered or unexported fields
}
func (CreatePlacementOutput) GoString ¶
func (s CreatePlacementOutput) 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 (CreatePlacementOutput) String ¶
func (s CreatePlacementOutput) 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 CreateProjectInput ¶
type CreateProjectInput struct { // An optional description for the project. Description *string `locationName:"description" type:"string"` // The schema defining the placement to be created. A placement template defines // placement default attributes and device templates. You cannot add or remove // device templates after the project has been created. However, you can update // callbackOverrides for the device templates using the UpdateProject API. PlacementTemplate *PlacementTemplate `locationName:"placementTemplate" type:"structure"` // The name of the project to create. // // ProjectName is a required field ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"` // Optional tags (metadata key/value pairs) to be associated with the project. // For example, { {"key1": "value1", "key2": "value2"} }. For more information, // see AWS Tagging Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/). Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (CreateProjectInput) GoString ¶
func (s CreateProjectInput) 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 (*CreateProjectInput) SetDescription ¶
func (s *CreateProjectInput) SetDescription(v string) *CreateProjectInput
SetDescription sets the Description field's value.
func (*CreateProjectInput) SetPlacementTemplate ¶
func (s *CreateProjectInput) SetPlacementTemplate(v *PlacementTemplate) *CreateProjectInput
SetPlacementTemplate sets the PlacementTemplate field's value.
func (*CreateProjectInput) SetProjectName ¶
func (s *CreateProjectInput) SetProjectName(v string) *CreateProjectInput
SetProjectName sets the ProjectName field's value.
func (*CreateProjectInput) SetTags ¶ added in v1.19.1
func (s *CreateProjectInput) SetTags(v map[string]*string) *CreateProjectInput
SetTags sets the Tags field's value.
func (CreateProjectInput) String ¶
func (s CreateProjectInput) 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 (*CreateProjectInput) Validate ¶
func (s *CreateProjectInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateProjectOutput ¶
type CreateProjectOutput struct {
// contains filtered or unexported fields
}
func (CreateProjectOutput) GoString ¶
func (s CreateProjectOutput) 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 (CreateProjectOutput) String ¶
func (s CreateProjectOutput) 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 DeletePlacementInput ¶
type DeletePlacementInput struct { // The name of the empty placement to delete. // // PlacementName is a required field PlacementName *string `location:"uri" locationName:"placementName" min:"1" type:"string" required:"true"` // The project containing the empty placement to delete. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeletePlacementInput) GoString ¶
func (s DeletePlacementInput) 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 (*DeletePlacementInput) SetPlacementName ¶
func (s *DeletePlacementInput) SetPlacementName(v string) *DeletePlacementInput
SetPlacementName sets the PlacementName field's value.
func (*DeletePlacementInput) SetProjectName ¶
func (s *DeletePlacementInput) SetProjectName(v string) *DeletePlacementInput
SetProjectName sets the ProjectName field's value.
func (DeletePlacementInput) String ¶
func (s DeletePlacementInput) 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 (*DeletePlacementInput) Validate ¶
func (s *DeletePlacementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeletePlacementOutput ¶
type DeletePlacementOutput struct {
// contains filtered or unexported fields
}
func (DeletePlacementOutput) GoString ¶
func (s DeletePlacementOutput) 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 (DeletePlacementOutput) String ¶
func (s DeletePlacementOutput) 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 DeleteProjectInput ¶
type DeleteProjectInput struct { // The name of the empty project to delete. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteProjectInput) GoString ¶
func (s DeleteProjectInput) 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 (*DeleteProjectInput) SetProjectName ¶
func (s *DeleteProjectInput) SetProjectName(v string) *DeleteProjectInput
SetProjectName sets the ProjectName field's value.
func (DeleteProjectInput) String ¶
func (s DeleteProjectInput) 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 (*DeleteProjectInput) Validate ¶
func (s *DeleteProjectInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteProjectOutput ¶
type DeleteProjectOutput struct {
// contains filtered or unexported fields
}
func (DeleteProjectOutput) GoString ¶
func (s DeleteProjectOutput) 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 (DeleteProjectOutput) String ¶
func (s DeleteProjectOutput) 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 DescribePlacementInput ¶
type DescribePlacementInput struct { // The name of the placement within a project. // // PlacementName is a required field PlacementName *string `location:"uri" locationName:"placementName" min:"1" type:"string" required:"true"` // The project containing the placement to be described. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribePlacementInput) GoString ¶
func (s DescribePlacementInput) 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 (*DescribePlacementInput) SetPlacementName ¶
func (s *DescribePlacementInput) SetPlacementName(v string) *DescribePlacementInput
SetPlacementName sets the PlacementName field's value.
func (*DescribePlacementInput) SetProjectName ¶
func (s *DescribePlacementInput) SetProjectName(v string) *DescribePlacementInput
SetProjectName sets the ProjectName field's value.
func (DescribePlacementInput) String ¶
func (s DescribePlacementInput) 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 (*DescribePlacementInput) Validate ¶
func (s *DescribePlacementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribePlacementOutput ¶
type DescribePlacementOutput struct { // An object describing the placement. // // Placement is a required field Placement *PlacementDescription `locationName:"placement" type:"structure" required:"true"` // contains filtered or unexported fields }
func (DescribePlacementOutput) GoString ¶
func (s DescribePlacementOutput) 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 (*DescribePlacementOutput) SetPlacement ¶
func (s *DescribePlacementOutput) SetPlacement(v *PlacementDescription) *DescribePlacementOutput
SetPlacement sets the Placement field's value.
func (DescribePlacementOutput) String ¶
func (s DescribePlacementOutput) 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 DescribeProjectInput ¶
type DescribeProjectInput struct { // The name of the project to be described. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeProjectInput) GoString ¶
func (s DescribeProjectInput) 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 (*DescribeProjectInput) SetProjectName ¶
func (s *DescribeProjectInput) SetProjectName(v string) *DescribeProjectInput
SetProjectName sets the ProjectName field's value.
func (DescribeProjectInput) String ¶
func (s DescribeProjectInput) 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 (*DescribeProjectInput) Validate ¶
func (s *DescribeProjectInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeProjectOutput ¶
type DescribeProjectOutput struct { // An object describing the project. // // Project is a required field Project *ProjectDescription `locationName:"project" type:"structure" required:"true"` // contains filtered or unexported fields }
func (DescribeProjectOutput) GoString ¶
func (s DescribeProjectOutput) 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 (*DescribeProjectOutput) SetProject ¶
func (s *DescribeProjectOutput) SetProject(v *ProjectDescription) *DescribeProjectOutput
SetProject sets the Project field's value.
func (DescribeProjectOutput) String ¶
func (s DescribeProjectOutput) 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 DeviceTemplate ¶
type DeviceTemplate struct { // An optional Lambda function to invoke instead of the default Lambda function // provided by the placement template. CallbackOverrides map[string]*string `locationName:"callbackOverrides" type:"map"` // The device type, which currently must be "button". DeviceType *string `locationName:"deviceType" type:"string"` // contains filtered or unexported fields }
An object representing a device for a placement template (see PlacementTemplate).
func (DeviceTemplate) GoString ¶
func (s DeviceTemplate) 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 (*DeviceTemplate) SetCallbackOverrides ¶
func (s *DeviceTemplate) SetCallbackOverrides(v map[string]*string) *DeviceTemplate
SetCallbackOverrides sets the CallbackOverrides field's value.
func (*DeviceTemplate) SetDeviceType ¶
func (s *DeviceTemplate) SetDeviceType(v string) *DeviceTemplate
SetDeviceType sets the DeviceType field's value.
func (DeviceTemplate) String ¶
func (s DeviceTemplate) 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 DisassociateDeviceFromPlacementInput ¶
type DisassociateDeviceFromPlacementInput struct { // The device ID that should be removed from the placement. // // DeviceTemplateName is a required field DeviceTemplateName *string `location:"uri" locationName:"deviceTemplateName" min:"1" type:"string" required:"true"` // The name of the placement that the device should be removed from. // // PlacementName is a required field PlacementName *string `location:"uri" locationName:"placementName" min:"1" type:"string" required:"true"` // The name of the project that contains the placement. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DisassociateDeviceFromPlacementInput) GoString ¶
func (s DisassociateDeviceFromPlacementInput) 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 (*DisassociateDeviceFromPlacementInput) SetDeviceTemplateName ¶
func (s *DisassociateDeviceFromPlacementInput) SetDeviceTemplateName(v string) *DisassociateDeviceFromPlacementInput
SetDeviceTemplateName sets the DeviceTemplateName field's value.
func (*DisassociateDeviceFromPlacementInput) SetPlacementName ¶
func (s *DisassociateDeviceFromPlacementInput) SetPlacementName(v string) *DisassociateDeviceFromPlacementInput
SetPlacementName sets the PlacementName field's value.
func (*DisassociateDeviceFromPlacementInput) SetProjectName ¶
func (s *DisassociateDeviceFromPlacementInput) SetProjectName(v string) *DisassociateDeviceFromPlacementInput
SetProjectName sets the ProjectName field's value.
func (DisassociateDeviceFromPlacementInput) String ¶
func (s DisassociateDeviceFromPlacementInput) 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 (*DisassociateDeviceFromPlacementInput) Validate ¶
func (s *DisassociateDeviceFromPlacementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisassociateDeviceFromPlacementOutput ¶
type DisassociateDeviceFromPlacementOutput struct {
// contains filtered or unexported fields
}
func (DisassociateDeviceFromPlacementOutput) GoString ¶
func (s DisassociateDeviceFromPlacementOutput) 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 (DisassociateDeviceFromPlacementOutput) String ¶
func (s DisassociateDeviceFromPlacementOutput) 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 GetDevicesInPlacementInput ¶
type GetDevicesInPlacementInput struct { // The name of the placement to get the devices from. // // PlacementName is a required field PlacementName *string `location:"uri" locationName:"placementName" min:"1" type:"string" required:"true"` // The name of the project containing the placement. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetDevicesInPlacementInput) GoString ¶
func (s GetDevicesInPlacementInput) 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 (*GetDevicesInPlacementInput) SetPlacementName ¶
func (s *GetDevicesInPlacementInput) SetPlacementName(v string) *GetDevicesInPlacementInput
SetPlacementName sets the PlacementName field's value.
func (*GetDevicesInPlacementInput) SetProjectName ¶
func (s *GetDevicesInPlacementInput) SetProjectName(v string) *GetDevicesInPlacementInput
SetProjectName sets the ProjectName field's value.
func (GetDevicesInPlacementInput) String ¶
func (s GetDevicesInPlacementInput) 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 (*GetDevicesInPlacementInput) Validate ¶
func (s *GetDevicesInPlacementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetDevicesInPlacementOutput ¶
type GetDevicesInPlacementOutput struct { // An object containing the devices (zero or more) within the placement. // // Devices is a required field Devices map[string]*string `locationName:"devices" type:"map" required:"true"` // contains filtered or unexported fields }
func (GetDevicesInPlacementOutput) GoString ¶
func (s GetDevicesInPlacementOutput) 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 (*GetDevicesInPlacementOutput) SetDevices ¶
func (s *GetDevicesInPlacementOutput) SetDevices(v map[string]*string) *GetDevicesInPlacementOutput
SetDevices sets the Devices field's value.
func (GetDevicesInPlacementOutput) String ¶
func (s GetDevicesInPlacementOutput) 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 ¶ added in v1.28.0
type InternalFailureException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Code_ *string `locationName:"code" type:"string"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
func (*InternalFailureException) Code ¶ added in v1.28.0
func (s *InternalFailureException) Code() string
Code returns the exception type name.
func (*InternalFailureException) Error ¶ added in v1.28.0
func (s *InternalFailureException) Error() string
func (InternalFailureException) GoString ¶ added in v1.28.0
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 ¶ added in v1.28.0
func (s *InternalFailureException) Message() string
Message returns the exception's message.
func (*InternalFailureException) OrigErr ¶ added in v1.28.0
func (s *InternalFailureException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*InternalFailureException) RequestID ¶ added in v1.28.0
func (s *InternalFailureException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*InternalFailureException) StatusCode ¶ added in v1.28.0
func (s *InternalFailureException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (InternalFailureException) String ¶ added in v1.28.0
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 ¶ added in v1.28.0
type InvalidRequestException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Code_ *string `locationName:"code" type:"string"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
func (*InvalidRequestException) Code ¶ added in v1.28.0
func (s *InvalidRequestException) Code() string
Code returns the exception type name.
func (*InvalidRequestException) Error ¶ added in v1.28.0
func (s *InvalidRequestException) Error() string
func (InvalidRequestException) GoString ¶ added in v1.28.0
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 ¶ added in v1.28.0
func (s *InvalidRequestException) Message() string
Message returns the exception's message.
func (*InvalidRequestException) OrigErr ¶ added in v1.28.0
func (s *InvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*InvalidRequestException) RequestID ¶ added in v1.28.0
func (s *InvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*InvalidRequestException) StatusCode ¶ added in v1.28.0
func (s *InvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (InvalidRequestException) String ¶ added in v1.28.0
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 IoT1ClickProjects ¶
IoT1ClickProjects provides the API operation methods for making requests to AWS IoT 1-Click Projects Service. See this package's package overview docs for details on the service.
IoT1ClickProjects 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) *IoT1ClickProjects
New creates a new instance of the IoT1ClickProjects 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 IoT1ClickProjects client from just a session. svc := iot1clickprojects.New(mySession) // Create a IoT1ClickProjects client with additional configuration svc := iot1clickprojects.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*IoT1ClickProjects) AssociateDeviceWithPlacement ¶
func (c *IoT1ClickProjects) AssociateDeviceWithPlacement(input *AssociateDeviceWithPlacementInput) (*AssociateDeviceWithPlacementOutput, error)
AssociateDeviceWithPlacement API operation for AWS IoT 1-Click Projects Service.
Associates a physical device with a placement.
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 1-Click Projects Service's API operation AssociateDeviceWithPlacement for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceConflictException
ResourceNotFoundException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/AssociateDeviceWithPlacement
func (*IoT1ClickProjects) AssociateDeviceWithPlacementRequest ¶
func (c *IoT1ClickProjects) AssociateDeviceWithPlacementRequest(input *AssociateDeviceWithPlacementInput) (req *request.Request, output *AssociateDeviceWithPlacementOutput)
AssociateDeviceWithPlacementRequest generates a "aws/request.Request" representing the client's request for the AssociateDeviceWithPlacement 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 AssociateDeviceWithPlacement for more information on using the AssociateDeviceWithPlacement 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 AssociateDeviceWithPlacementRequest method. req, resp := client.AssociateDeviceWithPlacementRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/AssociateDeviceWithPlacement
func (*IoT1ClickProjects) AssociateDeviceWithPlacementWithContext ¶
func (c *IoT1ClickProjects) AssociateDeviceWithPlacementWithContext(ctx aws.Context, input *AssociateDeviceWithPlacementInput, opts ...request.Option) (*AssociateDeviceWithPlacementOutput, error)
AssociateDeviceWithPlacementWithContext is the same as AssociateDeviceWithPlacement with the addition of the ability to pass a context and additional request options.
See AssociateDeviceWithPlacement 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 (*IoT1ClickProjects) CreatePlacement ¶
func (c *IoT1ClickProjects) CreatePlacement(input *CreatePlacementInput) (*CreatePlacementOutput, error)
CreatePlacement API operation for AWS IoT 1-Click Projects Service.
Creates an empty placement.
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 1-Click Projects Service's API operation CreatePlacement for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceConflictException
ResourceNotFoundException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreatePlacement
func (*IoT1ClickProjects) CreatePlacementRequest ¶
func (c *IoT1ClickProjects) CreatePlacementRequest(input *CreatePlacementInput) (req *request.Request, output *CreatePlacementOutput)
CreatePlacementRequest generates a "aws/request.Request" representing the client's request for the CreatePlacement 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 CreatePlacement for more information on using the CreatePlacement 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 CreatePlacementRequest method. req, resp := client.CreatePlacementRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreatePlacement
func (*IoT1ClickProjects) CreatePlacementWithContext ¶
func (c *IoT1ClickProjects) CreatePlacementWithContext(ctx aws.Context, input *CreatePlacementInput, opts ...request.Option) (*CreatePlacementOutput, error)
CreatePlacementWithContext is the same as CreatePlacement with the addition of the ability to pass a context and additional request options.
See CreatePlacement 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 (*IoT1ClickProjects) CreateProject ¶
func (c *IoT1ClickProjects) CreateProject(input *CreateProjectInput) (*CreateProjectOutput, error)
CreateProject API operation for AWS IoT 1-Click Projects Service.
Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.
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 1-Click Projects Service's API operation CreateProject for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceConflictException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreateProject
func (*IoT1ClickProjects) CreateProjectRequest ¶
func (c *IoT1ClickProjects) CreateProjectRequest(input *CreateProjectInput) (req *request.Request, output *CreateProjectOutput)
CreateProjectRequest generates a "aws/request.Request" representing the client's request for the CreateProject 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 CreateProject for more information on using the CreateProject 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 CreateProjectRequest method. req, resp := client.CreateProjectRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreateProject
func (*IoT1ClickProjects) CreateProjectWithContext ¶
func (c *IoT1ClickProjects) CreateProjectWithContext(ctx aws.Context, input *CreateProjectInput, opts ...request.Option) (*CreateProjectOutput, error)
CreateProjectWithContext is the same as CreateProject with the addition of the ability to pass a context and additional request options.
See CreateProject 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 (*IoT1ClickProjects) DeletePlacement ¶
func (c *IoT1ClickProjects) DeletePlacement(input *DeletePlacementInput) (*DeletePlacementOutput, error)
DeletePlacement API operation for AWS IoT 1-Click Projects Service.
Deletes a placement. To delete a placement, it must not have any devices associated with it.
When you delete a placement, all associated data becomes irretrievable.
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 1-Click Projects Service's API operation DeletePlacement for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
TooManyRequestsException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeletePlacement
func (*IoT1ClickProjects) DeletePlacementRequest ¶
func (c *IoT1ClickProjects) DeletePlacementRequest(input *DeletePlacementInput) (req *request.Request, output *DeletePlacementOutput)
DeletePlacementRequest generates a "aws/request.Request" representing the client's request for the DeletePlacement 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 DeletePlacement for more information on using the DeletePlacement 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 DeletePlacementRequest method. req, resp := client.DeletePlacementRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeletePlacement
func (*IoT1ClickProjects) DeletePlacementWithContext ¶
func (c *IoT1ClickProjects) DeletePlacementWithContext(ctx aws.Context, input *DeletePlacementInput, opts ...request.Option) (*DeletePlacementOutput, error)
DeletePlacementWithContext is the same as DeletePlacement with the addition of the ability to pass a context and additional request options.
See DeletePlacement 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 (*IoT1ClickProjects) DeleteProject ¶
func (c *IoT1ClickProjects) DeleteProject(input *DeleteProjectInput) (*DeleteProjectOutput, error)
DeleteProject API operation for AWS IoT 1-Click Projects Service.
Deletes a project. To delete a project, it must not have any placements associated with it.
When you delete a project, all associated data becomes irretrievable.
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 1-Click Projects Service's API operation DeleteProject for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
TooManyRequestsException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeleteProject
func (*IoT1ClickProjects) DeleteProjectRequest ¶
func (c *IoT1ClickProjects) DeleteProjectRequest(input *DeleteProjectInput) (req *request.Request, output *DeleteProjectOutput)
DeleteProjectRequest generates a "aws/request.Request" representing the client's request for the DeleteProject 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 DeleteProject for more information on using the DeleteProject 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 DeleteProjectRequest method. req, resp := client.DeleteProjectRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeleteProject
func (*IoT1ClickProjects) DeleteProjectWithContext ¶
func (c *IoT1ClickProjects) DeleteProjectWithContext(ctx aws.Context, input *DeleteProjectInput, opts ...request.Option) (*DeleteProjectOutput, error)
DeleteProjectWithContext is the same as DeleteProject with the addition of the ability to pass a context and additional request options.
See DeleteProject 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 (*IoT1ClickProjects) DescribePlacement ¶
func (c *IoT1ClickProjects) DescribePlacement(input *DescribePlacementInput) (*DescribePlacementOutput, error)
DescribePlacement API operation for AWS IoT 1-Click Projects Service.
Describes a placement in a project.
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 1-Click Projects Service's API operation DescribePlacement for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribePlacement
func (*IoT1ClickProjects) DescribePlacementRequest ¶
func (c *IoT1ClickProjects) DescribePlacementRequest(input *DescribePlacementInput) (req *request.Request, output *DescribePlacementOutput)
DescribePlacementRequest generates a "aws/request.Request" representing the client's request for the DescribePlacement 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 DescribePlacement for more information on using the DescribePlacement 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 DescribePlacementRequest method. req, resp := client.DescribePlacementRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribePlacement
func (*IoT1ClickProjects) DescribePlacementWithContext ¶
func (c *IoT1ClickProjects) DescribePlacementWithContext(ctx aws.Context, input *DescribePlacementInput, opts ...request.Option) (*DescribePlacementOutput, error)
DescribePlacementWithContext is the same as DescribePlacement with the addition of the ability to pass a context and additional request options.
See DescribePlacement 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 (*IoT1ClickProjects) DescribeProject ¶
func (c *IoT1ClickProjects) DescribeProject(input *DescribeProjectInput) (*DescribeProjectOutput, error)
DescribeProject API operation for AWS IoT 1-Click Projects Service.
Returns an object describing a project.
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 1-Click Projects Service's API operation DescribeProject for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribeProject
func (*IoT1ClickProjects) DescribeProjectRequest ¶
func (c *IoT1ClickProjects) DescribeProjectRequest(input *DescribeProjectInput) (req *request.Request, output *DescribeProjectOutput)
DescribeProjectRequest generates a "aws/request.Request" representing the client's request for the DescribeProject 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 DescribeProject for more information on using the DescribeProject 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 DescribeProjectRequest method. req, resp := client.DescribeProjectRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribeProject
func (*IoT1ClickProjects) DescribeProjectWithContext ¶
func (c *IoT1ClickProjects) DescribeProjectWithContext(ctx aws.Context, input *DescribeProjectInput, opts ...request.Option) (*DescribeProjectOutput, error)
DescribeProjectWithContext is the same as DescribeProject with the addition of the ability to pass a context and additional request options.
See DescribeProject 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 (*IoT1ClickProjects) DisassociateDeviceFromPlacement ¶
func (c *IoT1ClickProjects) DisassociateDeviceFromPlacement(input *DisassociateDeviceFromPlacementInput) (*DisassociateDeviceFromPlacementOutput, error)
DisassociateDeviceFromPlacement API operation for AWS IoT 1-Click Projects Service.
Removes a physical device from a placement.
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 1-Click Projects Service's API operation DisassociateDeviceFromPlacement for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
TooManyRequestsException
func (*IoT1ClickProjects) DisassociateDeviceFromPlacementRequest ¶
func (c *IoT1ClickProjects) DisassociateDeviceFromPlacementRequest(input *DisassociateDeviceFromPlacementInput) (req *request.Request, output *DisassociateDeviceFromPlacementOutput)
DisassociateDeviceFromPlacementRequest generates a "aws/request.Request" representing the client's request for the DisassociateDeviceFromPlacement 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 DisassociateDeviceFromPlacement for more information on using the DisassociateDeviceFromPlacement 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 DisassociateDeviceFromPlacementRequest method. req, resp := client.DisassociateDeviceFromPlacementRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*IoT1ClickProjects) DisassociateDeviceFromPlacementWithContext ¶
func (c *IoT1ClickProjects) DisassociateDeviceFromPlacementWithContext(ctx aws.Context, input *DisassociateDeviceFromPlacementInput, opts ...request.Option) (*DisassociateDeviceFromPlacementOutput, error)
DisassociateDeviceFromPlacementWithContext is the same as DisassociateDeviceFromPlacement with the addition of the ability to pass a context and additional request options.
See DisassociateDeviceFromPlacement 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 (*IoT1ClickProjects) GetDevicesInPlacement ¶
func (c *IoT1ClickProjects) GetDevicesInPlacement(input *GetDevicesInPlacementInput) (*GetDevicesInPlacementOutput, error)
GetDevicesInPlacement API operation for AWS IoT 1-Click Projects Service.
Returns an object enumerating the devices in a placement.
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 1-Click Projects Service's API operation GetDevicesInPlacement for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/GetDevicesInPlacement
func (*IoT1ClickProjects) GetDevicesInPlacementRequest ¶
func (c *IoT1ClickProjects) GetDevicesInPlacementRequest(input *GetDevicesInPlacementInput) (req *request.Request, output *GetDevicesInPlacementOutput)
GetDevicesInPlacementRequest generates a "aws/request.Request" representing the client's request for the GetDevicesInPlacement 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 GetDevicesInPlacement for more information on using the GetDevicesInPlacement 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 GetDevicesInPlacementRequest method. req, resp := client.GetDevicesInPlacementRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/GetDevicesInPlacement
func (*IoT1ClickProjects) GetDevicesInPlacementWithContext ¶
func (c *IoT1ClickProjects) GetDevicesInPlacementWithContext(ctx aws.Context, input *GetDevicesInPlacementInput, opts ...request.Option) (*GetDevicesInPlacementOutput, error)
GetDevicesInPlacementWithContext is the same as GetDevicesInPlacement with the addition of the ability to pass a context and additional request options.
See GetDevicesInPlacement 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 (*IoT1ClickProjects) ListPlacements ¶
func (c *IoT1ClickProjects) ListPlacements(input *ListPlacementsInput) (*ListPlacementsOutput, error)
ListPlacements API operation for AWS IoT 1-Click Projects Service.
Lists the placement(s) of a project.
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 1-Click Projects Service's API operation ListPlacements for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListPlacements
func (*IoT1ClickProjects) ListPlacementsPages ¶ added in v1.19.27
func (c *IoT1ClickProjects) ListPlacementsPages(input *ListPlacementsInput, fn func(*ListPlacementsOutput, bool) bool) error
ListPlacementsPages iterates over the pages of a ListPlacements operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListPlacements 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 ListPlacements operation. pageNum := 0 err := client.ListPlacementsPages(params, func(page *iot1clickprojects.ListPlacementsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*IoT1ClickProjects) ListPlacementsPagesWithContext ¶ added in v1.19.27
func (c *IoT1ClickProjects) ListPlacementsPagesWithContext(ctx aws.Context, input *ListPlacementsInput, fn func(*ListPlacementsOutput, bool) bool, opts ...request.Option) error
ListPlacementsPagesWithContext same as ListPlacementsPages 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 (*IoT1ClickProjects) ListPlacementsRequest ¶
func (c *IoT1ClickProjects) ListPlacementsRequest(input *ListPlacementsInput) (req *request.Request, output *ListPlacementsOutput)
ListPlacementsRequest generates a "aws/request.Request" representing the client's request for the ListPlacements 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 ListPlacements for more information on using the ListPlacements 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 ListPlacementsRequest method. req, resp := client.ListPlacementsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListPlacements
func (*IoT1ClickProjects) ListPlacementsWithContext ¶
func (c *IoT1ClickProjects) ListPlacementsWithContext(ctx aws.Context, input *ListPlacementsInput, opts ...request.Option) (*ListPlacementsOutput, error)
ListPlacementsWithContext is the same as ListPlacements with the addition of the ability to pass a context and additional request options.
See ListPlacements 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 (*IoT1ClickProjects) ListProjects ¶
func (c *IoT1ClickProjects) ListProjects(input *ListProjectsInput) (*ListProjectsOutput, error)
ListProjects API operation for AWS IoT 1-Click Projects Service.
Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.
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 1-Click Projects Service's API operation ListProjects for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListProjects
func (*IoT1ClickProjects) ListProjectsPages ¶ added in v1.19.27
func (c *IoT1ClickProjects) ListProjectsPages(input *ListProjectsInput, fn func(*ListProjectsOutput, bool) bool) error
ListProjectsPages iterates over the pages of a ListProjects operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListProjects 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 ListProjects operation. pageNum := 0 err := client.ListProjectsPages(params, func(page *iot1clickprojects.ListProjectsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*IoT1ClickProjects) ListProjectsPagesWithContext ¶ added in v1.19.27
func (c *IoT1ClickProjects) ListProjectsPagesWithContext(ctx aws.Context, input *ListProjectsInput, fn func(*ListProjectsOutput, bool) bool, opts ...request.Option) error
ListProjectsPagesWithContext same as ListProjectsPages 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 (*IoT1ClickProjects) ListProjectsRequest ¶
func (c *IoT1ClickProjects) ListProjectsRequest(input *ListProjectsInput) (req *request.Request, output *ListProjectsOutput)
ListProjectsRequest generates a "aws/request.Request" representing the client's request for the ListProjects 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 ListProjects for more information on using the ListProjects 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 ListProjectsRequest method. req, resp := client.ListProjectsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListProjects
func (*IoT1ClickProjects) ListProjectsWithContext ¶
func (c *IoT1ClickProjects) ListProjectsWithContext(ctx aws.Context, input *ListProjectsInput, opts ...request.Option) (*ListProjectsOutput, error)
ListProjectsWithContext is the same as ListProjects with the addition of the ability to pass a context and additional request options.
See ListProjects 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 (*IoT1ClickProjects) ListTagsForResource ¶ added in v1.19.1
func (c *IoT1ClickProjects) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for AWS IoT 1-Click Projects Service.
Lists the tags (metadata key/value pairs) which you have assigned to the resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT 1-Click Projects Service's API operation ListTagsForResource for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListTagsForResource
func (*IoT1ClickProjects) ListTagsForResourceRequest ¶ added in v1.19.1
func (c *IoT1ClickProjects) 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/iot1click-projects-2018-05-14/ListTagsForResource
func (*IoT1ClickProjects) ListTagsForResourceWithContext ¶ added in v1.19.1
func (c *IoT1ClickProjects) 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 (*IoT1ClickProjects) TagResource ¶ added in v1.19.1
func (c *IoT1ClickProjects) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for AWS IoT 1-Click Projects Service.
Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies (https://aws.amazon.com/answers/account-management/aws-tagging-strategies/).
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 1-Click Projects Service's API operation TagResource for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/TagResource
func (*IoT1ClickProjects) TagResourceRequest ¶ added in v1.19.1
func (c *IoT1ClickProjects) 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/iot1click-projects-2018-05-14/TagResource
func (*IoT1ClickProjects) TagResourceWithContext ¶ added in v1.19.1
func (c *IoT1ClickProjects) 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 (*IoT1ClickProjects) UntagResource ¶ added in v1.19.1
func (c *IoT1ClickProjects) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for AWS IoT 1-Click Projects Service.
Removes one or more tags (metadata key/value pairs) from a resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS IoT 1-Click Projects Service's API operation UntagResource for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UntagResource
func (*IoT1ClickProjects) UntagResourceRequest ¶ added in v1.19.1
func (c *IoT1ClickProjects) 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/iot1click-projects-2018-05-14/UntagResource
func (*IoT1ClickProjects) UntagResourceWithContext ¶ added in v1.19.1
func (c *IoT1ClickProjects) 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 (*IoT1ClickProjects) UpdatePlacement ¶
func (c *IoT1ClickProjects) UpdatePlacement(input *UpdatePlacementInput) (*UpdatePlacementOutput, error)
UpdatePlacement API operation for AWS IoT 1-Click Projects Service.
Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., "").
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 1-Click Projects Service's API operation UpdatePlacement for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
TooManyRequestsException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdatePlacement
func (*IoT1ClickProjects) UpdatePlacementRequest ¶
func (c *IoT1ClickProjects) UpdatePlacementRequest(input *UpdatePlacementInput) (req *request.Request, output *UpdatePlacementOutput)
UpdatePlacementRequest generates a "aws/request.Request" representing the client's request for the UpdatePlacement 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 UpdatePlacement for more information on using the UpdatePlacement 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 UpdatePlacementRequest method. req, resp := client.UpdatePlacementRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdatePlacement
func (*IoT1ClickProjects) UpdatePlacementWithContext ¶
func (c *IoT1ClickProjects) UpdatePlacementWithContext(ctx aws.Context, input *UpdatePlacementInput, opts ...request.Option) (*UpdatePlacementOutput, error)
UpdatePlacementWithContext is the same as UpdatePlacement with the addition of the ability to pass a context and additional request options.
See UpdatePlacement 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 (*IoT1ClickProjects) UpdateProject ¶
func (c *IoT1ClickProjects) UpdateProject(input *UpdateProjectInput) (*UpdateProjectOutput, error)
UpdateProject API operation for AWS IoT 1-Click Projects Service.
Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., "").
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 1-Click Projects Service's API operation UpdateProject for usage and error information.
Returned Error Types:
InternalFailureException
InvalidRequestException
ResourceNotFoundException
TooManyRequestsException
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdateProject
func (*IoT1ClickProjects) UpdateProjectRequest ¶
func (c *IoT1ClickProjects) UpdateProjectRequest(input *UpdateProjectInput) (req *request.Request, output *UpdateProjectOutput)
UpdateProjectRequest generates a "aws/request.Request" representing the client's request for the UpdateProject 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 UpdateProject for more information on using the UpdateProject 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 UpdateProjectRequest method. req, resp := client.UpdateProjectRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdateProject
func (*IoT1ClickProjects) UpdateProjectWithContext ¶
func (c *IoT1ClickProjects) UpdateProjectWithContext(ctx aws.Context, input *UpdateProjectInput, opts ...request.Option) (*UpdateProjectOutput, error)
UpdateProjectWithContext is the same as UpdateProject with the addition of the ability to pass a context and additional request options.
See UpdateProject 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 ListPlacementsInput ¶
type ListPlacementsInput struct { // The maximum number of results to return per request. If not set, a default // value of 100 is used. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token to retrieve the next set of results. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // The project containing the placements to be listed. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListPlacementsInput) GoString ¶
func (s ListPlacementsInput) 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 (*ListPlacementsInput) SetMaxResults ¶
func (s *ListPlacementsInput) SetMaxResults(v int64) *ListPlacementsInput
SetMaxResults sets the MaxResults field's value.
func (*ListPlacementsInput) SetNextToken ¶
func (s *ListPlacementsInput) SetNextToken(v string) *ListPlacementsInput
SetNextToken sets the NextToken field's value.
func (*ListPlacementsInput) SetProjectName ¶
func (s *ListPlacementsInput) SetProjectName(v string) *ListPlacementsInput
SetProjectName sets the ProjectName field's value.
func (ListPlacementsInput) String ¶
func (s ListPlacementsInput) 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 (*ListPlacementsInput) Validate ¶
func (s *ListPlacementsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListPlacementsOutput ¶
type ListPlacementsOutput struct { // The token used to retrieve the next set of results - will be effectively // empty if there are no further results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // An object listing the requested placements. // // Placements is a required field Placements []*PlacementSummary `locationName:"placements" type:"list" required:"true"` // contains filtered or unexported fields }
func (ListPlacementsOutput) GoString ¶
func (s ListPlacementsOutput) 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 (*ListPlacementsOutput) SetNextToken ¶
func (s *ListPlacementsOutput) SetNextToken(v string) *ListPlacementsOutput
SetNextToken sets the NextToken field's value.
func (*ListPlacementsOutput) SetPlacements ¶
func (s *ListPlacementsOutput) SetPlacements(v []*PlacementSummary) *ListPlacementsOutput
SetPlacements sets the Placements field's value.
func (ListPlacementsOutput) String ¶
func (s ListPlacementsOutput) 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 ListProjectsInput ¶
type ListProjectsInput struct { // The maximum number of results to return per request. If not set, a default // value of 100 is used. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` // The token to retrieve the next set of results. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` // contains filtered or unexported fields }
func (ListProjectsInput) GoString ¶
func (s ListProjectsInput) 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 (*ListProjectsInput) SetMaxResults ¶
func (s *ListProjectsInput) SetMaxResults(v int64) *ListProjectsInput
SetMaxResults sets the MaxResults field's value.
func (*ListProjectsInput) SetNextToken ¶
func (s *ListProjectsInput) SetNextToken(v string) *ListProjectsInput
SetNextToken sets the NextToken field's value.
func (ListProjectsInput) String ¶
func (s ListProjectsInput) 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 (*ListProjectsInput) Validate ¶
func (s *ListProjectsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListProjectsOutput ¶
type ListProjectsOutput struct { // The token used to retrieve the next set of results - will be effectively // empty if there are no further results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` // An object containing the list of projects. // // Projects is a required field Projects []*ProjectSummary `locationName:"projects" type:"list" required:"true"` // contains filtered or unexported fields }
func (ListProjectsOutput) GoString ¶
func (s ListProjectsOutput) 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 (*ListProjectsOutput) SetNextToken ¶
func (s *ListProjectsOutput) SetNextToken(v string) *ListProjectsOutput
SetNextToken sets the NextToken field's value.
func (*ListProjectsOutput) SetProjects ¶
func (s *ListProjectsOutput) SetProjects(v []*ProjectSummary) *ListProjectsOutput
SetProjects sets the Projects field's value.
func (ListProjectsOutput) String ¶
func (s ListProjectsOutput) 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 ¶ added in v1.19.1
type ListTagsForResourceInput struct { // The ARN of the resource whose tags you want to list. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) GoString ¶ added in v1.19.1
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 ¶ added in v1.19.1
func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
SetResourceArn sets the ResourceArn field's value.
func (ListTagsForResourceInput) String ¶ added in v1.19.1
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 ¶ added in v1.19.1
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶ added in v1.19.1
type ListTagsForResourceOutput struct { // The tags (metadata key/value pairs) which you have assigned to the resource. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) GoString ¶ added in v1.19.1
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 ¶ added in v1.19.1
func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
func (ListTagsForResourceOutput) String ¶ added in v1.19.1
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 PlacementDescription ¶
type PlacementDescription struct { // The user-defined attributes associated with the placement. // // Attributes is a required field Attributes map[string]*string `locationName:"attributes" type:"map" required:"true"` // The date when the placement was initially created, in UNIX epoch time format. // // CreatedDate is a required field CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" required:"true"` // The name of the placement. // // PlacementName is a required field PlacementName *string `locationName:"placementName" min:"1" type:"string" required:"true"` // The name of the project containing the placement. // // ProjectName is a required field ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"` // The date when the placement was last updated, in UNIX epoch time format. // If the placement was not updated, then createdDate and updatedDate are the // same. // // UpdatedDate is a required field UpdatedDate *time.Time `locationName:"updatedDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
An object describing a project's placement.
func (PlacementDescription) GoString ¶
func (s PlacementDescription) 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 (*PlacementDescription) SetAttributes ¶
func (s *PlacementDescription) SetAttributes(v map[string]*string) *PlacementDescription
SetAttributes sets the Attributes field's value.
func (*PlacementDescription) SetCreatedDate ¶
func (s *PlacementDescription) SetCreatedDate(v time.Time) *PlacementDescription
SetCreatedDate sets the CreatedDate field's value.
func (*PlacementDescription) SetPlacementName ¶
func (s *PlacementDescription) SetPlacementName(v string) *PlacementDescription
SetPlacementName sets the PlacementName field's value.
func (*PlacementDescription) SetProjectName ¶
func (s *PlacementDescription) SetProjectName(v string) *PlacementDescription
SetProjectName sets the ProjectName field's value.
func (*PlacementDescription) SetUpdatedDate ¶
func (s *PlacementDescription) SetUpdatedDate(v time.Time) *PlacementDescription
SetUpdatedDate sets the UpdatedDate field's value.
func (PlacementDescription) String ¶
func (s PlacementDescription) 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 PlacementSummary ¶
type PlacementSummary struct { // The date when the placement was originally created, in UNIX epoch time format. // // CreatedDate is a required field CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" required:"true"` // The name of the placement being summarized. // // PlacementName is a required field PlacementName *string `locationName:"placementName" min:"1" type:"string" required:"true"` // The name of the project containing the placement. // // ProjectName is a required field ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"` // The date when the placement was last updated, in UNIX epoch time format. // If the placement was not updated, then createdDate and updatedDate are the // same. // // UpdatedDate is a required field UpdatedDate *time.Time `locationName:"updatedDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
An object providing summary information for a particular placement.
func (PlacementSummary) GoString ¶
func (s PlacementSummary) 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 (*PlacementSummary) SetCreatedDate ¶
func (s *PlacementSummary) SetCreatedDate(v time.Time) *PlacementSummary
SetCreatedDate sets the CreatedDate field's value.
func (*PlacementSummary) SetPlacementName ¶
func (s *PlacementSummary) SetPlacementName(v string) *PlacementSummary
SetPlacementName sets the PlacementName field's value.
func (*PlacementSummary) SetProjectName ¶
func (s *PlacementSummary) SetProjectName(v string) *PlacementSummary
SetProjectName sets the ProjectName field's value.
func (*PlacementSummary) SetUpdatedDate ¶
func (s *PlacementSummary) SetUpdatedDate(v time.Time) *PlacementSummary
SetUpdatedDate sets the UpdatedDate field's value.
func (PlacementSummary) String ¶
func (s PlacementSummary) 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 PlacementTemplate ¶
type PlacementTemplate struct { // The default attributes (key/value pairs) to be applied to all placements // using this template. DefaultAttributes map[string]*string `locationName:"defaultAttributes" type:"map"` // An object specifying the DeviceTemplate for all placements using this (PlacementTemplate) // template. DeviceTemplates map[string]*DeviceTemplate `locationName:"deviceTemplates" type:"map"` // contains filtered or unexported fields }
An object defining the template for a placement.
func (PlacementTemplate) GoString ¶
func (s PlacementTemplate) 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 (*PlacementTemplate) SetDefaultAttributes ¶
func (s *PlacementTemplate) SetDefaultAttributes(v map[string]*string) *PlacementTemplate
SetDefaultAttributes sets the DefaultAttributes field's value.
func (*PlacementTemplate) SetDeviceTemplates ¶
func (s *PlacementTemplate) SetDeviceTemplates(v map[string]*DeviceTemplate) *PlacementTemplate
SetDeviceTemplates sets the DeviceTemplates field's value.
func (PlacementTemplate) String ¶
func (s PlacementTemplate) 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 ProjectDescription ¶
type ProjectDescription struct { // The ARN of the project. Arn *string `locationName:"arn" type:"string"` // The date when the project was originally created, in UNIX epoch time format. // // CreatedDate is a required field CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" required:"true"` // The description of the project. Description *string `locationName:"description" type:"string"` // An object describing the project's placement specifications. PlacementTemplate *PlacementTemplate `locationName:"placementTemplate" type:"structure"` // The name of the project for which to obtain information from. // // ProjectName is a required field ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"` // The tags (metadata key/value pairs) associated with the project. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // The date when the project was last updated, in UNIX epoch time format. If // the project was not updated, then createdDate and updatedDate are the same. // // UpdatedDate is a required field UpdatedDate *time.Time `locationName:"updatedDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
An object providing detailed information for a particular project associated with an AWS account and region.
func (ProjectDescription) GoString ¶
func (s ProjectDescription) 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 (*ProjectDescription) SetArn ¶ added in v1.19.1
func (s *ProjectDescription) SetArn(v string) *ProjectDescription
SetArn sets the Arn field's value.
func (*ProjectDescription) SetCreatedDate ¶
func (s *ProjectDescription) SetCreatedDate(v time.Time) *ProjectDescription
SetCreatedDate sets the CreatedDate field's value.
func (*ProjectDescription) SetDescription ¶
func (s *ProjectDescription) SetDescription(v string) *ProjectDescription
SetDescription sets the Description field's value.
func (*ProjectDescription) SetPlacementTemplate ¶
func (s *ProjectDescription) SetPlacementTemplate(v *PlacementTemplate) *ProjectDescription
SetPlacementTemplate sets the PlacementTemplate field's value.
func (*ProjectDescription) SetProjectName ¶
func (s *ProjectDescription) SetProjectName(v string) *ProjectDescription
SetProjectName sets the ProjectName field's value.
func (*ProjectDescription) SetTags ¶ added in v1.19.1
func (s *ProjectDescription) SetTags(v map[string]*string) *ProjectDescription
SetTags sets the Tags field's value.
func (*ProjectDescription) SetUpdatedDate ¶
func (s *ProjectDescription) SetUpdatedDate(v time.Time) *ProjectDescription
SetUpdatedDate sets the UpdatedDate field's value.
func (ProjectDescription) String ¶
func (s ProjectDescription) 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 ProjectSummary ¶
type ProjectSummary struct { // The ARN of the project. Arn *string `locationName:"arn" type:"string"` // The date when the project was originally created, in UNIX epoch time format. // // CreatedDate is a required field CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" required:"true"` // The name of the project being summarized. // // ProjectName is a required field ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"` // The tags (metadata key/value pairs) associated with the project. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` // The date when the project was last updated, in UNIX epoch time format. If // the project was not updated, then createdDate and updatedDate are the same. // // UpdatedDate is a required field UpdatedDate *time.Time `locationName:"updatedDate" type:"timestamp" required:"true"` // contains filtered or unexported fields }
An object providing summary information for a particular project for an associated AWS account and region.
func (ProjectSummary) GoString ¶
func (s ProjectSummary) 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 (*ProjectSummary) SetArn ¶ added in v1.19.1
func (s *ProjectSummary) SetArn(v string) *ProjectSummary
SetArn sets the Arn field's value.
func (*ProjectSummary) SetCreatedDate ¶
func (s *ProjectSummary) SetCreatedDate(v time.Time) *ProjectSummary
SetCreatedDate sets the CreatedDate field's value.
func (*ProjectSummary) SetProjectName ¶
func (s *ProjectSummary) SetProjectName(v string) *ProjectSummary
SetProjectName sets the ProjectName field's value.
func (*ProjectSummary) SetTags ¶ added in v1.19.1
func (s *ProjectSummary) SetTags(v map[string]*string) *ProjectSummary
SetTags sets the Tags field's value.
func (*ProjectSummary) SetUpdatedDate ¶
func (s *ProjectSummary) SetUpdatedDate(v time.Time) *ProjectSummary
SetUpdatedDate sets the UpdatedDate field's value.
func (ProjectSummary) String ¶
func (s ProjectSummary) 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 ResourceConflictException ¶ added in v1.28.0
type ResourceConflictException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Code_ *string `locationName:"code" type:"string"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
func (*ResourceConflictException) Code ¶ added in v1.28.0
func (s *ResourceConflictException) Code() string
Code returns the exception type name.
func (*ResourceConflictException) Error ¶ added in v1.28.0
func (s *ResourceConflictException) Error() string
func (ResourceConflictException) GoString ¶ added in v1.28.0
func (s ResourceConflictException) 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 (*ResourceConflictException) Message ¶ added in v1.28.0
func (s *ResourceConflictException) Message() string
Message returns the exception's message.
func (*ResourceConflictException) OrigErr ¶ added in v1.28.0
func (s *ResourceConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ResourceConflictException) RequestID ¶ added in v1.28.0
func (s *ResourceConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ResourceConflictException) StatusCode ¶ added in v1.28.0
func (s *ResourceConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ResourceConflictException) String ¶ added in v1.28.0
func (s ResourceConflictException) 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 ¶ added in v1.28.0
type ResourceNotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Code_ *string `locationName:"code" type:"string"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
func (*ResourceNotFoundException) Code ¶ added in v1.28.0
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (*ResourceNotFoundException) Error ¶ added in v1.28.0
func (s *ResourceNotFoundException) Error() string
func (ResourceNotFoundException) GoString ¶ added in v1.28.0
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 ¶ added in v1.28.0
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (*ResourceNotFoundException) OrigErr ¶ added in v1.28.0
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ResourceNotFoundException) RequestID ¶ added in v1.28.0
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ResourceNotFoundException) StatusCode ¶ added in v1.28.0
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ResourceNotFoundException) String ¶ added in v1.28.0
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 ¶ added in v1.19.1
type TagResourceInput struct { // The ARN of the resouce for which tag(s) should be added or modified. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // The new or modifying tag(s) for the resource. See AWS IoT 1-Click Service // Limits (https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits) // for the maximum number of tags allowed per 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 ¶ added in v1.19.1
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 ¶ added in v1.19.1
func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (*TagResourceInput) SetTags ¶ added in v1.19.1
func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput
SetTags sets the Tags field's value.
func (TagResourceInput) String ¶ added in v1.19.1
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 ¶ added in v1.19.1
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶ added in v1.19.1
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) GoString ¶ added in v1.19.1
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 ¶ added in v1.19.1
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 TooManyRequestsException ¶ added in v1.28.0
type TooManyRequestsException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Code_ *string `locationName:"code" type:"string"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
func (*TooManyRequestsException) Code ¶ added in v1.28.0
func (s *TooManyRequestsException) Code() string
Code returns the exception type name.
func (*TooManyRequestsException) Error ¶ added in v1.28.0
func (s *TooManyRequestsException) Error() string
func (TooManyRequestsException) GoString ¶ added in v1.28.0
func (s TooManyRequestsException) 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 (*TooManyRequestsException) Message ¶ added in v1.28.0
func (s *TooManyRequestsException) Message() string
Message returns the exception's message.
func (*TooManyRequestsException) OrigErr ¶ added in v1.28.0
func (s *TooManyRequestsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*TooManyRequestsException) RequestID ¶ added in v1.28.0
func (s *TooManyRequestsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*TooManyRequestsException) StatusCode ¶ added in v1.28.0
func (s *TooManyRequestsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (TooManyRequestsException) String ¶ added in v1.28.0
func (s TooManyRequestsException) 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 ¶ added in v1.19.1
type UntagResourceInput struct { // The ARN of the resource whose tag you want to remove. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` // The keys of those tags which you want to remove. // // TagKeys is a required field TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (UntagResourceInput) GoString ¶ added in v1.19.1
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 ¶ added in v1.19.1
func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (*UntagResourceInput) SetTagKeys ¶ added in v1.19.1
func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput
SetTagKeys sets the TagKeys field's value.
func (UntagResourceInput) String ¶ added in v1.19.1
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 ¶ added in v1.19.1
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶ added in v1.19.1
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) GoString ¶ added in v1.19.1
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 ¶ added in v1.19.1
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 UpdatePlacementInput ¶
type UpdatePlacementInput struct { // The user-defined object of attributes used to update the placement. The maximum // number of key/value pairs is 50. Attributes map[string]*string `locationName:"attributes" type:"map"` // The name of the placement to update. // // PlacementName is a required field PlacementName *string `location:"uri" locationName:"placementName" min:"1" type:"string" required:"true"` // The name of the project containing the placement to be updated. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdatePlacementInput) GoString ¶
func (s UpdatePlacementInput) 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 (*UpdatePlacementInput) SetAttributes ¶
func (s *UpdatePlacementInput) SetAttributes(v map[string]*string) *UpdatePlacementInput
SetAttributes sets the Attributes field's value.
func (*UpdatePlacementInput) SetPlacementName ¶
func (s *UpdatePlacementInput) SetPlacementName(v string) *UpdatePlacementInput
SetPlacementName sets the PlacementName field's value.
func (*UpdatePlacementInput) SetProjectName ¶
func (s *UpdatePlacementInput) SetProjectName(v string) *UpdatePlacementInput
SetProjectName sets the ProjectName field's value.
func (UpdatePlacementInput) String ¶
func (s UpdatePlacementInput) 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 (*UpdatePlacementInput) Validate ¶
func (s *UpdatePlacementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdatePlacementOutput ¶
type UpdatePlacementOutput struct {
// contains filtered or unexported fields
}
func (UpdatePlacementOutput) GoString ¶
func (s UpdatePlacementOutput) 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 (UpdatePlacementOutput) String ¶
func (s UpdatePlacementOutput) 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 UpdateProjectInput ¶
type UpdateProjectInput struct { // An optional user-defined description for the project. Description *string `locationName:"description" type:"string"` // An object defining the project update. Once a project has been created, you // cannot add device template names to the project. However, for a given placementTemplate, // you can update the associated callbackOverrides for the device definition // using this API. PlacementTemplate *PlacementTemplate `locationName:"placementTemplate" type:"structure"` // The name of the project to be updated. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateProjectInput) GoString ¶
func (s UpdateProjectInput) 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 (*UpdateProjectInput) SetDescription ¶
func (s *UpdateProjectInput) SetDescription(v string) *UpdateProjectInput
SetDescription sets the Description field's value.
func (*UpdateProjectInput) SetPlacementTemplate ¶
func (s *UpdateProjectInput) SetPlacementTemplate(v *PlacementTemplate) *UpdateProjectInput
SetPlacementTemplate sets the PlacementTemplate field's value.
func (*UpdateProjectInput) SetProjectName ¶
func (s *UpdateProjectInput) SetProjectName(v string) *UpdateProjectInput
SetProjectName sets the ProjectName field's value.
func (UpdateProjectInput) String ¶
func (s UpdateProjectInput) 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 (*UpdateProjectInput) Validate ¶
func (s *UpdateProjectInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateProjectOutput ¶
type UpdateProjectOutput struct {
// contains filtered or unexported fields
}
func (UpdateProjectOutput) GoString ¶
func (s UpdateProjectOutput) 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 (UpdateProjectOutput) String ¶
func (s UpdateProjectOutput) 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 iot1clickprojectsiface provides an interface to enable mocking the AWS IoT 1-Click Projects Service service client for testing your code.
|
Package iot1clickprojectsiface provides an interface to enable mocking the AWS IoT 1-Click Projects Service service client for testing your code. |