iot1clickprojects

package
v0.11.0 Latest Latest
Warning

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

 Go to latest Published: Aug 23, 2019 License: Apache-2.0 Imports: 7 Imported by: 9

Documentation

Overview

Package iot1clickprojects provides the client and types for making API requests to AWS IoT 1-Click Projects.

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 use AWS IoT 1-Click Projects 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 client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iot1clickprojects/#New

Index

Constants

View Source 
const (
	ServiceName = "AWS IoT 1-Click Projects" // Service's name
	ServiceID   = "IoT1ClickProjects"        // Service's identifier
	EndpointsID = "projects.iot1click"       // Service's Endpoint identifier
)
View Source 
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"
)

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/AssociateDeviceWithPlacementRequest

func (AssociateDeviceWithPlacementInput) MarshalFields 

func (s AssociateDeviceWithPlacementInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssociateDeviceWithPlacementInput) String 

func (s AssociateDeviceWithPlacementInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/AssociateDeviceWithPlacementResponse

func (AssociateDeviceWithPlacementOutput) MarshalFields 

func (s AssociateDeviceWithPlacementOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (AssociateDeviceWithPlacementOutput) String 

func (s AssociateDeviceWithPlacementOutput) String() string

String returns the string representation

type AssociateDeviceWithPlacementRequest 

type AssociateDeviceWithPlacementRequest struct {
	*aws.Request
	Input *AssociateDeviceWithPlacementInput
	Copy  func(*AssociateDeviceWithPlacementInput) AssociateDeviceWithPlacementRequest
}

AssociateDeviceWithPlacementRequest is the request type for the AssociateDeviceWithPlacement API operation.

func (AssociateDeviceWithPlacementRequest) Send 

func (r AssociateDeviceWithPlacementRequest) Send(ctx context.Context) (*AssociateDeviceWithPlacementResponse, error)

Send marshals and sends the AssociateDeviceWithPlacement API request.

type AssociateDeviceWithPlacementResponse added in v0.9.0 

type AssociateDeviceWithPlacementResponse struct {
	*AssociateDeviceWithPlacementOutput
	// contains filtered or unexported fields
}

AssociateDeviceWithPlacementResponse is the response type for the AssociateDeviceWithPlacement API operation.

func (*AssociateDeviceWithPlacementResponse) SDKResponseMetdata added in v0.9.0 

func (r *AssociateDeviceWithPlacementResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AssociateDeviceWithPlacement request.

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to AWS IoT 1-Click Projects. See this package's package overview docs for details on the service.

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := iot1clickprojects.New(myConfig)

func (*Client) AssociateDeviceWithPlacementRequest added in v0.9.0 

func (c *Client) AssociateDeviceWithPlacementRequest(input *AssociateDeviceWithPlacementInput) AssociateDeviceWithPlacementRequest

AssociateDeviceWithPlacementRequest returns a request value for making API operation for AWS IoT 1-Click Projects Service.

Associates a physical device with a placement. 

// Example sending a request using AssociateDeviceWithPlacementRequest.
req := client.AssociateDeviceWithPlacementRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/AssociateDeviceWithPlacement

func (*Client) CreatePlacementRequest added in v0.9.0 

func (c *Client) CreatePlacementRequest(input *CreatePlacementInput) CreatePlacementRequest

CreatePlacementRequest returns a request value for making API operation for AWS IoT 1-Click Projects Service.

Creates an empty placement. 

// Example sending a request using CreatePlacementRequest.
req := client.CreatePlacementRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreatePlacement

func (*Client) CreateProjectRequest added in v0.9.0 

func (c *Client) CreateProjectRequest(input *CreateProjectInput) CreateProjectRequest

CreateProjectRequest returns a request value for making 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. 

// Example sending a request using CreateProjectRequest.
req := client.CreateProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreateProject

func (*Client) DeletePlacementRequest added in v0.9.0 

func (c *Client) DeletePlacementRequest(input *DeletePlacementInput) DeletePlacementRequest

DeletePlacementRequest returns a request value for making 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. 

// Example sending a request using DeletePlacementRequest.
req := client.DeletePlacementRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeletePlacement

func (*Client) DeleteProjectRequest added in v0.9.0 

func (c *Client) DeleteProjectRequest(input *DeleteProjectInput) DeleteProjectRequest

DeleteProjectRequest returns a request value for making 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. 

// Example sending a request using DeleteProjectRequest.
req := client.DeleteProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeleteProject

func (*Client) DescribePlacementRequest added in v0.9.0 

func (c *Client) DescribePlacementRequest(input *DescribePlacementInput) DescribePlacementRequest

DescribePlacementRequest returns a request value for making API operation for AWS IoT 1-Click Projects Service.

Describes a placement in a project. 

// Example sending a request using DescribePlacementRequest.
req := client.DescribePlacementRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribePlacement

func (*Client) DescribeProjectRequest added in v0.9.0 

func (c *Client) DescribeProjectRequest(input *DescribeProjectInput) DescribeProjectRequest

DescribeProjectRequest returns a request value for making API operation for AWS IoT 1-Click Projects Service.

Returns an object describing a project. 

// Example sending a request using DescribeProjectRequest.
req := client.DescribeProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribeProject

func (*Client) DisassociateDeviceFromPlacementRequest added in v0.9.0 

func (c *Client) DisassociateDeviceFromPlacementRequest(input *DisassociateDeviceFromPlacementInput) DisassociateDeviceFromPlacementRequest

DisassociateDeviceFromPlacementRequest returns a request value for making API operation for AWS IoT 1-Click Projects Service.

Removes a physical device from a placement. 

// Example sending a request using DisassociateDeviceFromPlacementRequest.
req := client.DisassociateDeviceFromPlacementRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DisassociateDeviceFromPlacement

func (*Client) GetDevicesInPlacementRequest added in v0.9.0 

func (c *Client) GetDevicesInPlacementRequest(input *GetDevicesInPlacementInput) GetDevicesInPlacementRequest

GetDevicesInPlacementRequest returns a request value for making API operation for AWS IoT 1-Click Projects Service.

Returns an object enumerating the devices in a placement. 

// Example sending a request using GetDevicesInPlacementRequest.
req := client.GetDevicesInPlacementRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/GetDevicesInPlacement

func (*Client) ListPlacementsRequest added in v0.9.0 

func (c *Client) ListPlacementsRequest(input *ListPlacementsInput) ListPlacementsRequest

ListPlacementsRequest returns a request value for making API operation for AWS IoT 1-Click Projects Service.

Lists the placement(s) of a project. 

// Example sending a request using ListPlacementsRequest.
req := client.ListPlacementsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListPlacements

func (*Client) ListProjectsRequest added in v0.9.0 

func (c *Client) ListProjectsRequest(input *ListProjectsInput) ListProjectsRequest

ListProjectsRequest returns a request value for making API operation for AWS IoT 1-Click Projects Service.

Lists the AWS IoT 1-Click project(s) associated with your AWS account and region. 

// Example sending a request using ListProjectsRequest.
req := client.ListProjectsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListProjects

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS IoT 1-Click Projects Service.

Lists the tags (metadata key/value pairs) which you have assigned to the resource. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListTagsForResource

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making 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/). 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/TagResource

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS IoT 1-Click Projects Service.

Removes one or more tags (metadata key/value pairs) from a resource. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UntagResource

func (*Client) UpdatePlacementRequest added in v0.9.0 

func (c *Client) UpdatePlacementRequest(input *UpdatePlacementInput) UpdatePlacementRequest

UpdatePlacementRequest returns a request value for making 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., ""). 

// Example sending a request using UpdatePlacementRequest.
req := client.UpdatePlacementRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdatePlacement

func (*Client) UpdateProjectRequest added in v0.9.0 

func (c *Client) UpdateProjectRequest(input *UpdateProjectInput) UpdateProjectRequest

UpdateProjectRequest returns a request value for making 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., ""). 

// Example sending a request using UpdateProjectRequest.
req := client.UpdateProjectRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdateProject

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreatePlacementRequest

func (CreatePlacementInput) MarshalFields 

func (s CreatePlacementInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreatePlacementInput) String 

func (s CreatePlacementInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreatePlacementResponse

func (CreatePlacementOutput) MarshalFields 

func (s CreatePlacementOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreatePlacementOutput) String 

func (s CreatePlacementOutput) String() string

String returns the string representation

type CreatePlacementRequest 

type CreatePlacementRequest struct {
	*aws.Request
	Input *CreatePlacementInput
	Copy  func(*CreatePlacementInput) CreatePlacementRequest
}

CreatePlacementRequest is the request type for the CreatePlacement API operation.

func (CreatePlacementRequest) Send 

func (r CreatePlacementRequest) Send(ctx context.Context) (*CreatePlacementResponse, error)

Send marshals and sends the CreatePlacement API request.

type CreatePlacementResponse added in v0.9.0 

type CreatePlacementResponse struct {
	*CreatePlacementOutput
	// contains filtered or unexported fields
}

CreatePlacementResponse is the response type for the CreatePlacement API operation.

func (*CreatePlacementResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreatePlacementResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreatePlacement request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreateProjectRequest

func (CreateProjectInput) MarshalFields 

func (s CreateProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateProjectInput) String 

func (s CreateProjectInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreateProjectResponse

func (CreateProjectOutput) MarshalFields 

func (s CreateProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateProjectOutput) String 

func (s CreateProjectOutput) String() string

String returns the string representation

type CreateProjectRequest 

type CreateProjectRequest struct {
	*aws.Request
	Input *CreateProjectInput
	Copy  func(*CreateProjectInput) CreateProjectRequest
}

CreateProjectRequest is the request type for the CreateProject API operation.

func (CreateProjectRequest) Send 

func (r CreateProjectRequest) Send(ctx context.Context) (*CreateProjectResponse, error)

Send marshals and sends the CreateProject API request.

type CreateProjectResponse added in v0.9.0 

type CreateProjectResponse struct {
	*CreateProjectOutput
	// contains filtered or unexported fields
}

CreateProjectResponse is the response type for the CreateProject API operation.

func (*CreateProjectResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateProject request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeletePlacementRequest

func (DeletePlacementInput) MarshalFields 

func (s DeletePlacementInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePlacementInput) String 

func (s DeletePlacementInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeletePlacementResponse

func (DeletePlacementOutput) MarshalFields 

func (s DeletePlacementOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeletePlacementOutput) String 

func (s DeletePlacementOutput) String() string

String returns the string representation

type DeletePlacementRequest 

type DeletePlacementRequest struct {
	*aws.Request
	Input *DeletePlacementInput
	Copy  func(*DeletePlacementInput) DeletePlacementRequest
}

DeletePlacementRequest is the request type for the DeletePlacement API operation.

func (DeletePlacementRequest) Send 

func (r DeletePlacementRequest) Send(ctx context.Context) (*DeletePlacementResponse, error)

Send marshals and sends the DeletePlacement API request.

type DeletePlacementResponse added in v0.9.0 

type DeletePlacementResponse struct {
	*DeletePlacementOutput
	// contains filtered or unexported fields
}

DeletePlacementResponse is the response type for the DeletePlacement API operation.

func (*DeletePlacementResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeletePlacementResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeletePlacement request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeleteProjectRequest

func (DeleteProjectInput) MarshalFields 

func (s DeleteProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteProjectInput) String 

func (s DeleteProjectInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeleteProjectResponse

func (DeleteProjectOutput) MarshalFields 

func (s DeleteProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteProjectOutput) String 

func (s DeleteProjectOutput) String() string

String returns the string representation

type DeleteProjectRequest 

type DeleteProjectRequest struct {
	*aws.Request
	Input *DeleteProjectInput
	Copy  func(*DeleteProjectInput) DeleteProjectRequest
}

DeleteProjectRequest is the request type for the DeleteProject API operation.

func (DeleteProjectRequest) Send 

func (r DeleteProjectRequest) Send(ctx context.Context) (*DeleteProjectResponse, error)

Send marshals and sends the DeleteProject API request.

type DeleteProjectResponse added in v0.9.0 

type DeleteProjectResponse struct {
	*DeleteProjectOutput
	// contains filtered or unexported fields
}

DeleteProjectResponse is the response type for the DeleteProject API operation.

func (*DeleteProjectResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteProject request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribePlacementRequest

func (DescribePlacementInput) MarshalFields 

func (s DescribePlacementInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribePlacementInput) String 

func (s DescribePlacementInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribePlacementResponse

func (DescribePlacementOutput) MarshalFields 

func (s DescribePlacementOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribePlacementOutput) String 

func (s DescribePlacementOutput) String() string

String returns the string representation

type DescribePlacementRequest 

type DescribePlacementRequest struct {
	*aws.Request
	Input *DescribePlacementInput
	Copy  func(*DescribePlacementInput) DescribePlacementRequest
}

DescribePlacementRequest is the request type for the DescribePlacement API operation.

func (DescribePlacementRequest) Send 

func (r DescribePlacementRequest) Send(ctx context.Context) (*DescribePlacementResponse, error)

Send marshals and sends the DescribePlacement API request.

type DescribePlacementResponse added in v0.9.0 

type DescribePlacementResponse struct {
	*DescribePlacementOutput
	// contains filtered or unexported fields
}

DescribePlacementResponse is the response type for the DescribePlacement API operation.

func (*DescribePlacementResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribePlacementResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribePlacement request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribeProjectRequest

func (DescribeProjectInput) MarshalFields 

func (s DescribeProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeProjectInput) String 

func (s DescribeProjectInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribeProjectResponse

func (DescribeProjectOutput) MarshalFields 

func (s DescribeProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeProjectOutput) String 

func (s DescribeProjectOutput) String() string

String returns the string representation

type DescribeProjectRequest 

type DescribeProjectRequest struct {
	*aws.Request
	Input *DescribeProjectInput
	Copy  func(*DescribeProjectInput) DescribeProjectRequest
}

DescribeProjectRequest is the request type for the DescribeProject API operation.

func (DescribeProjectRequest) Send 

func (r DescribeProjectRequest) Send(ctx context.Context) (*DescribeProjectResponse, error)

Send marshals and sends the DescribeProject API request.

type DescribeProjectResponse added in v0.9.0 

type DescribeProjectResponse struct {
	*DescribeProjectOutput
	// contains filtered or unexported fields
}

DescribeProjectResponse is the response type for the DescribeProject API operation.

func (*DescribeProjectResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeProject request.

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). Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeviceTemplate

func (DeviceTemplate) MarshalFields 

func (s DeviceTemplate) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeviceTemplate) String 

func (s DeviceTemplate) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DisassociateDeviceFromPlacementRequest

func (DisassociateDeviceFromPlacementInput) MarshalFields 

func (s DisassociateDeviceFromPlacementInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DisassociateDeviceFromPlacementInput) String 

func (s DisassociateDeviceFromPlacementInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DisassociateDeviceFromPlacementResponse

func (DisassociateDeviceFromPlacementOutput) MarshalFields 

func (s DisassociateDeviceFromPlacementOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DisassociateDeviceFromPlacementOutput) String 

func (s DisassociateDeviceFromPlacementOutput) String() string

String returns the string representation

type DisassociateDeviceFromPlacementRequest 

type DisassociateDeviceFromPlacementRequest struct {
	*aws.Request
	Input *DisassociateDeviceFromPlacementInput
	Copy  func(*DisassociateDeviceFromPlacementInput) DisassociateDeviceFromPlacementRequest
}

DisassociateDeviceFromPlacementRequest is the request type for the DisassociateDeviceFromPlacement API operation.

func (DisassociateDeviceFromPlacementRequest) Send 

func (r DisassociateDeviceFromPlacementRequest) Send(ctx context.Context) (*DisassociateDeviceFromPlacementResponse, error)

Send marshals and sends the DisassociateDeviceFromPlacement API request.

type DisassociateDeviceFromPlacementResponse added in v0.9.0 

type DisassociateDeviceFromPlacementResponse struct {
	*DisassociateDeviceFromPlacementOutput
	// contains filtered or unexported fields
}

DisassociateDeviceFromPlacementResponse is the response type for the DisassociateDeviceFromPlacement API operation.

func (*DisassociateDeviceFromPlacementResponse) SDKResponseMetdata added in v0.9.0 

func (r *DisassociateDeviceFromPlacementResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DisassociateDeviceFromPlacement request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/GetDevicesInPlacementRequest

func (GetDevicesInPlacementInput) MarshalFields 

func (s GetDevicesInPlacementInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDevicesInPlacementInput) String 

func (s GetDevicesInPlacementInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/GetDevicesInPlacementResponse

func (GetDevicesInPlacementOutput) MarshalFields 

func (s GetDevicesInPlacementOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (GetDevicesInPlacementOutput) String 

func (s GetDevicesInPlacementOutput) String() string

String returns the string representation

type GetDevicesInPlacementRequest 

type GetDevicesInPlacementRequest struct {
	*aws.Request
	Input *GetDevicesInPlacementInput
	Copy  func(*GetDevicesInPlacementInput) GetDevicesInPlacementRequest
}

GetDevicesInPlacementRequest is the request type for the GetDevicesInPlacement API operation.

func (GetDevicesInPlacementRequest) Send 

func (r GetDevicesInPlacementRequest) Send(ctx context.Context) (*GetDevicesInPlacementResponse, error)

Send marshals and sends the GetDevicesInPlacement API request.

type GetDevicesInPlacementResponse added in v0.9.0 

type GetDevicesInPlacementResponse struct {
	*GetDevicesInPlacementOutput
	// contains filtered or unexported fields
}

GetDevicesInPlacementResponse is the response type for the GetDevicesInPlacement API operation.

func (*GetDevicesInPlacementResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetDevicesInPlacementResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetDevicesInPlacement request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListPlacementsRequest

func (ListPlacementsInput) MarshalFields 

func (s ListPlacementsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPlacementsInput) String 

func (s ListPlacementsInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListPlacementsResponse

func (ListPlacementsOutput) MarshalFields 

func (s ListPlacementsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListPlacementsOutput) String 

func (s ListPlacementsOutput) String() string

String returns the string representation

type ListPlacementsPaginator added in v0.9.0 

type ListPlacementsPaginator struct {
	aws.Pager
}

ListPlacementsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListPlacementsPaginator added in v0.9.0 

func NewListPlacementsPaginator(req ListPlacementsRequest) ListPlacementsPaginator

NewListPlacementsRequestPaginator returns a paginator for ListPlacements. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListPlacementsRequest(input)
p := iot1clickprojects.NewListPlacementsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListPlacementsPaginator) CurrentPage added in v0.9.0 

func (p *ListPlacementsPaginator) CurrentPage() *ListPlacementsOutput

type ListPlacementsRequest 

type ListPlacementsRequest struct {
	*aws.Request
	Input *ListPlacementsInput
	Copy  func(*ListPlacementsInput) ListPlacementsRequest
}

ListPlacementsRequest is the request type for the ListPlacements API operation.

func (ListPlacementsRequest) Send 

func (r ListPlacementsRequest) Send(ctx context.Context) (*ListPlacementsResponse, error)

Send marshals and sends the ListPlacements API request.

type ListPlacementsResponse added in v0.9.0 

type ListPlacementsResponse struct {
	*ListPlacementsOutput
	// contains filtered or unexported fields
}

ListPlacementsResponse is the response type for the ListPlacements API operation.

func (*ListPlacementsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListPlacementsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPlacements request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListProjectsRequest

func (ListProjectsInput) MarshalFields 

func (s ListProjectsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProjectsInput) String 

func (s ListProjectsInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListProjectsResponse

func (ListProjectsOutput) MarshalFields 

func (s ListProjectsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProjectsOutput) String 

func (s ListProjectsOutput) String() string

String returns the string representation

type ListProjectsPaginator added in v0.9.0 

type ListProjectsPaginator struct {
	aws.Pager
}

ListProjectsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListProjectsPaginator added in v0.9.0 

func NewListProjectsPaginator(req ListProjectsRequest) ListProjectsPaginator

NewListProjectsRequestPaginator returns a paginator for ListProjects. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListProjectsRequest(input)
p := iot1clickprojects.NewListProjectsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListProjectsPaginator) CurrentPage added in v0.9.0 

func (p *ListProjectsPaginator) CurrentPage() *ListProjectsOutput

type ListProjectsRequest 

type ListProjectsRequest struct {
	*aws.Request
	Input *ListProjectsInput
	Copy  func(*ListProjectsInput) ListProjectsRequest
}

ListProjectsRequest is the request type for the ListProjects API operation.

func (ListProjectsRequest) Send 

func (r ListProjectsRequest) Send(ctx context.Context) (*ListProjectsResponse, error)

Send marshals and sends the ListProjects API request.

type ListProjectsResponse added in v0.9.0 

type ListProjectsResponse struct {
	*ListProjectsOutput
	// contains filtered or unexported fields
}

ListProjectsResponse is the response type for the ListProjects API operation.

func (*ListProjectsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListProjectsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListProjects request.

type ListTagsForResourceInput added in v0.8.0 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListTagsForResourceRequest

func (ListTagsForResourceInput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceInput) String added in v0.8.0 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate added in v0.8.0 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput added in v0.8.0 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListTagsForResourceResponse

func (ListTagsForResourceOutput) MarshalFields added in v0.8.0 

func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListTagsForResourceOutput) String added in v0.8.0 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest added in v0.8.0 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send added in v0.8.0 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/PlacementDescription

func (PlacementDescription) MarshalFields 

func (s PlacementDescription) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PlacementDescription) String 

func (s PlacementDescription) String() string

String returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/PlacementSummary

func (PlacementSummary) MarshalFields 

func (s PlacementSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PlacementSummary) String 

func (s PlacementSummary) String() string

String returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/PlacementTemplate

func (PlacementTemplate) MarshalFields 

func (s PlacementTemplate) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (PlacementTemplate) String 

func (s PlacementTemplate) String() string

String returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ProjectDescription

func (ProjectDescription) MarshalFields 

func (s ProjectDescription) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ProjectDescription) String 

func (s ProjectDescription) String() string

String returns the string representation

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ProjectSummary

func (ProjectSummary) MarshalFields 

func (s ProjectSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ProjectSummary) String 

func (s ProjectSummary) String() string

String returns the string representation

type TagResourceInput added in v0.8.0 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/TagResourceRequest

func (TagResourceInput) MarshalFields added in v0.8.0 

func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceInput) String added in v0.8.0 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate added in v0.8.0 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v0.8.0 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/TagResourceResponse

func (TagResourceOutput) MarshalFields added in v0.8.0 

func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (TagResourceOutput) String added in v0.8.0 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest added in v0.8.0 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send added in v0.8.0 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

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

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type UntagResourceInput added in v0.8.0 

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UntagResourceRequest

func (UntagResourceInput) MarshalFields added in v0.8.0 

func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceInput) String added in v0.8.0 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate added in v0.8.0 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v0.8.0 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UntagResourceResponse

func (UntagResourceOutput) MarshalFields added in v0.8.0 

func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UntagResourceOutput) String added in v0.8.0 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest added in v0.8.0 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send added in v0.8.0 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

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

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdatePlacementRequest

func (UpdatePlacementInput) MarshalFields 

func (s UpdatePlacementInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdatePlacementInput) String 

func (s UpdatePlacementInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdatePlacementResponse

func (UpdatePlacementOutput) MarshalFields 

func (s UpdatePlacementOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdatePlacementOutput) String 

func (s UpdatePlacementOutput) String() string

String returns the string representation

type UpdatePlacementRequest 

type UpdatePlacementRequest struct {
	*aws.Request
	Input *UpdatePlacementInput
	Copy  func(*UpdatePlacementInput) UpdatePlacementRequest
}

UpdatePlacementRequest is the request type for the UpdatePlacement API operation.

func (UpdatePlacementRequest) Send 

func (r UpdatePlacementRequest) Send(ctx context.Context) (*UpdatePlacementResponse, error)

Send marshals and sends the UpdatePlacement API request.

type UpdatePlacementResponse added in v0.9.0 

type UpdatePlacementResponse struct {
	*UpdatePlacementOutput
	// contains filtered or unexported fields
}

UpdatePlacementResponse is the response type for the UpdatePlacement API operation.

func (*UpdatePlacementResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdatePlacementResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdatePlacement request.

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdateProjectRequest

func (UpdateProjectInput) MarshalFields 

func (s UpdateProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateProjectInput) String 

func (s UpdateProjectInput) String() string

String returns the string representation

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdateProjectResponse

func (UpdateProjectOutput) MarshalFields 

func (s UpdateProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateProjectOutput) String 

func (s UpdateProjectOutput) String() string

String returns the string representation

type UpdateProjectRequest 

type UpdateProjectRequest struct {
	*aws.Request
	Input *UpdateProjectInput
	Copy  func(*UpdateProjectInput) UpdateProjectRequest
}

UpdateProjectRequest is the request type for the UpdateProject API operation.

func (UpdateProjectRequest) Send 

func (r UpdateProjectRequest) Send(ctx context.Context) (*UpdateProjectResponse, error)

Send marshals and sends the UpdateProject API request.

type UpdateProjectResponse added in v0.9.0 

type UpdateProjectResponse struct {
	*UpdateProjectOutput
	// contains filtered or unexported fields
}

UpdateProjectResponse is the response type for the UpdateProject API operation.

func (*UpdateProjectResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateProjectResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateProject request.

Source Files

View all Source files

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.

Jump to

Keyboard shortcuts

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