AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

IoT1ClickProjects

import "github.com/aws/aws-sdk-go/service/iot1clickprojects"

type IoT1ClickProjects struct { *client.Client }

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.

Client

Type: *client.Client

Method

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceConflictException "ResourceConflictException"

  • ErrCodeResourceNotFoundException "ResourceNotFoundException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceConflictException "ResourceConflictException"

  • ErrCodeResourceNotFoundException "ResourceNotFoundException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceConflictException "ResourceConflictException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceNotFoundException "ResourceNotFoundException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceNotFoundException "ResourceNotFoundException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceNotFoundException "ResourceNotFoundException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceNotFoundException "ResourceNotFoundException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceNotFoundException "ResourceNotFoundException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

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) }

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceNotFoundException "ResourceNotFoundException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceNotFoundException "ResourceNotFoundException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceNotFoundException "ResourceNotFoundException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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 Codes:

  • ErrCodeInternalFailureException "InternalFailureException"

  • ErrCodeInvalidRequestException "InvalidRequestException"

  • ErrCodeResourceNotFoundException "ResourceNotFoundException"

  • ErrCodeTooManyRequestsException "TooManyRequestsException"

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

On this page: