Documentation ¶
Overview ¶
Package iot1clickprojects provides the client and types for making API requests to AWS IoT 1-Click Projects Service.
The AWS IoT 1-Click Project 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 AWS IoT 1-Click Projects Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS IoT 1-Click Projects Service client IoT1ClickProjects for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iot1clickprojects/#New
Index ¶
- Constants
- type AssociateDeviceWithPlacementInput
- type AssociateDeviceWithPlacementOutput
- type AssociateDeviceWithPlacementRequest
- type CreatePlacementInput
- type CreatePlacementOutput
- type CreatePlacementRequest
- type CreateProjectInput
- type CreateProjectOutput
- type CreateProjectRequest
- type DeletePlacementInput
- type DeletePlacementOutput
- type DeletePlacementRequest
- type DeleteProjectInput
- type DeleteProjectOutput
- type DeleteProjectRequest
- type DescribePlacementInput
- type DescribePlacementOutput
- type DescribePlacementRequest
- type DescribeProjectInput
- type DescribeProjectOutput
- type DescribeProjectRequest
- type DeviceTemplate
- type DisassociateDeviceFromPlacementInput
- type DisassociateDeviceFromPlacementOutput
- func (s DisassociateDeviceFromPlacementOutput) GoString() string
- func (s DisassociateDeviceFromPlacementOutput) MarshalFields(e protocol.FieldEncoder) error
- func (s DisassociateDeviceFromPlacementOutput) SDKResponseMetadata() aws.Response
- func (s DisassociateDeviceFromPlacementOutput) String() string
- type DisassociateDeviceFromPlacementRequest
- type GetDevicesInPlacementInput
- type GetDevicesInPlacementOutput
- type GetDevicesInPlacementRequest
- type IoT1ClickProjects
- func (c *IoT1ClickProjects) AssociateDeviceWithPlacementRequest(input *AssociateDeviceWithPlacementInput) AssociateDeviceWithPlacementRequest
- func (c *IoT1ClickProjects) CreatePlacementRequest(input *CreatePlacementInput) CreatePlacementRequest
- func (c *IoT1ClickProjects) CreateProjectRequest(input *CreateProjectInput) CreateProjectRequest
- func (c *IoT1ClickProjects) DeletePlacementRequest(input *DeletePlacementInput) DeletePlacementRequest
- func (c *IoT1ClickProjects) DeleteProjectRequest(input *DeleteProjectInput) DeleteProjectRequest
- func (c *IoT1ClickProjects) DescribePlacementRequest(input *DescribePlacementInput) DescribePlacementRequest
- func (c *IoT1ClickProjects) DescribeProjectRequest(input *DescribeProjectInput) DescribeProjectRequest
- func (c *IoT1ClickProjects) DisassociateDeviceFromPlacementRequest(input *DisassociateDeviceFromPlacementInput) DisassociateDeviceFromPlacementRequest
- func (c *IoT1ClickProjects) GetDevicesInPlacementRequest(input *GetDevicesInPlacementInput) GetDevicesInPlacementRequest
- func (c *IoT1ClickProjects) ListPlacementsRequest(input *ListPlacementsInput) ListPlacementsRequest
- func (c *IoT1ClickProjects) ListProjectsRequest(input *ListProjectsInput) ListProjectsRequest
- func (c *IoT1ClickProjects) UpdatePlacementRequest(input *UpdatePlacementInput) UpdatePlacementRequest
- func (c *IoT1ClickProjects) UpdateProjectRequest(input *UpdateProjectInput) UpdateProjectRequest
- type ListPlacementsInput
- type ListPlacementsOutput
- type ListPlacementsRequest
- type ListProjectsInput
- type ListProjectsOutput
- type ListProjectsRequest
- type PlacementDescription
- type PlacementSummary
- type PlacementTemplate
- type ProjectDescription
- type ProjectSummary
- type UpdatePlacementInput
- type UpdatePlacementOutput
- type UpdatePlacementRequest
- type UpdateProjectInput
- type UpdateProjectOutput
- type UpdateProjectRequest
Constants ¶
const ( // ErrCodeInternalFailureException for service response error code // "InternalFailureException". ErrCodeInternalFailureException = "InternalFailureException" // ErrCodeInvalidRequestException for service response error code // "InvalidRequestException". ErrCodeInvalidRequestException = "InvalidRequestException" // ErrCodeResourceConflictException for service response error code // "ResourceConflictException". ErrCodeResourceConflictException = "ResourceConflictException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeTooManyRequestsException for service response error code // "TooManyRequestsException". ErrCodeTooManyRequestsException = "TooManyRequestsException" )
const ( ServiceName = "projects.iot1click" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AssociateDeviceWithPlacementInput ¶
type AssociateDeviceWithPlacementInput struct { // The ID of the physical device to be associated with the given placement in // the project. Note that a mandatory 4 character prefix is required for all // deviceId values. // // DeviceId is a required field DeviceId *string `locationName:"deviceId" min:"1" type:"string" required:"true"` // The device template name to associate with the device ID. // // DeviceTemplateName is a required field DeviceTemplateName *string `location:"uri" locationName:"deviceTemplateName" min:"1" type:"string" required:"true"` // The name of the placement in which to associate the device. // // PlacementName is a required field PlacementName *string `location:"uri" locationName:"placementName" min:"1" type:"string" required:"true"` // The name of the project containing the placement in which to associate the // device. // // ProjectName is a required field ProjectName *string `location:"uri" locationName:"projectName" min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/AssociateDeviceWithPlacementRequest
func (AssociateDeviceWithPlacementInput) GoString ¶
func (s AssociateDeviceWithPlacementInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s AssociateDeviceWithPlacementOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s AssociateDeviceWithPlacementOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the AssociateDeviceWithPlacement API operation.
func (AssociateDeviceWithPlacementRequest) Send ¶
func (r AssociateDeviceWithPlacementRequest) Send() (*AssociateDeviceWithPlacementOutput, error)
Send marshals and sends the AssociateDeviceWithPlacement API request.
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) GoString ¶
func (s CreatePlacementInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s CreatePlacementOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s CreatePlacementOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the CreatePlacement API operation.
func (CreatePlacementRequest) Send ¶
func (r CreatePlacementRequest) Send() (*CreatePlacementOutput, error)
Send marshals and sends the CreatePlacement API 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"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreateProjectRequest
func (CreateProjectInput) GoString ¶
func (s CreateProjectInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s CreateProjectOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s CreateProjectOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the CreateProject API operation.
func (CreateProjectRequest) Send ¶
func (r CreateProjectRequest) Send() (*CreateProjectOutput, error)
Send marshals and sends the CreateProject API 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) GoString ¶
func (s DeletePlacementInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s DeletePlacementOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s DeletePlacementOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DeletePlacement API operation.
func (DeletePlacementRequest) Send ¶
func (r DeletePlacementRequest) Send() (*DeletePlacementOutput, error)
Send marshals and sends the DeletePlacement API 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) GoString ¶
func (s DeleteProjectInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s DeleteProjectOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s DeleteProjectOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DeleteProject API operation.
func (DeleteProjectRequest) Send ¶
func (r DeleteProjectRequest) Send() (*DeleteProjectOutput, error)
Send marshals and sends the DeleteProject API 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) GoString ¶
func (s DescribePlacementInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s DescribePlacementOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s DescribePlacementOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DescribePlacement API operation.
func (DescribePlacementRequest) Send ¶
func (r DescribePlacementRequest) Send() (*DescribePlacementOutput, error)
Send marshals and sends the DescribePlacement API 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) GoString ¶
func (s DescribeProjectInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s DescribeProjectOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s DescribeProjectOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DescribeProject API operation.
func (DescribeProjectRequest) Send ¶
func (r DescribeProjectRequest) Send() (*DescribeProjectOutput, error)
Send marshals and sends the DescribeProject API 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) GoString ¶
func (s DeviceTemplate) GoString() string
GoString returns the string representation
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) GoString ¶
func (s DisassociateDeviceFromPlacementInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s DisassociateDeviceFromPlacementOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s DisassociateDeviceFromPlacementOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the DisassociateDeviceFromPlacement API operation.
func (DisassociateDeviceFromPlacementRequest) Send ¶
func (r DisassociateDeviceFromPlacementRequest) Send() (*DisassociateDeviceFromPlacementOutput, error)
Send marshals and sends the DisassociateDeviceFromPlacement API 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) GoString ¶
func (s GetDevicesInPlacementInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s GetDevicesInPlacementOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s GetDevicesInPlacementOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the GetDevicesInPlacement API operation.
func (GetDevicesInPlacementRequest) Send ¶
func (r GetDevicesInPlacementRequest) Send() (*GetDevicesInPlacementOutput, error)
Send marshals and sends the GetDevicesInPlacement API request.
type IoT1ClickProjects ¶
IoT1ClickProjects provides the API operation methods for making requests to AWS IoT 1-Click Projects Service. See this package's package overview docs for details on the service.
IoT1ClickProjects methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(config aws.Config) *IoT1ClickProjects
New creates a new instance of the IoT1ClickProjects client with a config.
Example:
// Create a IoT1ClickProjects client from just a config. svc := iot1clickprojects.New(myConfig)
func (*IoT1ClickProjects) AssociateDeviceWithPlacementRequest ¶
func (c *IoT1ClickProjects) 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 the AssociateDeviceWithPlacementRequest method. req := client.AssociateDeviceWithPlacementRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/AssociateDeviceWithPlacement
func (*IoT1ClickProjects) CreatePlacementRequest ¶
func (c *IoT1ClickProjects) 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 the CreatePlacementRequest method. req := client.CreatePlacementRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreatePlacement
func (*IoT1ClickProjects) CreateProjectRequest ¶
func (c *IoT1ClickProjects) 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 the CreateProjectRequest method. req := client.CreateProjectRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/CreateProject
func (*IoT1ClickProjects) DeletePlacementRequest ¶
func (c *IoT1ClickProjects) 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 the DeletePlacementRequest method. req := client.DeletePlacementRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeletePlacement
func (*IoT1ClickProjects) DeleteProjectRequest ¶
func (c *IoT1ClickProjects) 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 the DeleteProjectRequest method. req := client.DeleteProjectRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DeleteProject
func (*IoT1ClickProjects) DescribePlacementRequest ¶
func (c *IoT1ClickProjects) 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 the DescribePlacementRequest method. req := client.DescribePlacementRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribePlacement
func (*IoT1ClickProjects) DescribeProjectRequest ¶
func (c *IoT1ClickProjects) 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 the DescribeProjectRequest method. req := client.DescribeProjectRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DescribeProject
func (*IoT1ClickProjects) DisassociateDeviceFromPlacementRequest ¶
func (c *IoT1ClickProjects) 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 the DisassociateDeviceFromPlacementRequest method. req := client.DisassociateDeviceFromPlacementRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/DisassociateDeviceFromPlacement
func (*IoT1ClickProjects) GetDevicesInPlacementRequest ¶
func (c *IoT1ClickProjects) 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 the GetDevicesInPlacementRequest method. req := client.GetDevicesInPlacementRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/GetDevicesInPlacement
func (*IoT1ClickProjects) ListPlacementsRequest ¶
func (c *IoT1ClickProjects) 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 the ListPlacementsRequest method. req := client.ListPlacementsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListPlacements
func (*IoT1ClickProjects) ListProjectsRequest ¶
func (c *IoT1ClickProjects) 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 the ListProjectsRequest method. req := client.ListProjectsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/ListProjects
func (*IoT1ClickProjects) UpdatePlacementRequest ¶
func (c *IoT1ClickProjects) 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 the UpdatePlacementRequest method. req := client.UpdatePlacementRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdatePlacement
func (*IoT1ClickProjects) UpdateProjectRequest ¶
func (c *IoT1ClickProjects) 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 the UpdateProjectRequest method. req := client.UpdateProjectRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/iot1click-projects-2018-05-14/UpdateProject
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) GoString ¶
func (s ListPlacementsInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s ListPlacementsOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s ListPlacementsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListPlacementsOutput) String ¶
func (s ListPlacementsOutput) String() string
String returns the string representation
type ListPlacementsRequest ¶
type ListPlacementsRequest struct { *aws.Request Input *ListPlacementsInput Copy func(*ListPlacementsInput) ListPlacementsRequest }
ListPlacementsRequest is a API request type for the ListPlacements API operation.
func (ListPlacementsRequest) Send ¶
func (r ListPlacementsRequest) Send() (*ListPlacementsOutput, error)
Send marshals and sends the ListPlacements API 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) GoString ¶
func (s ListProjectsInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s ListProjectsOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s ListProjectsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListProjectsOutput) String ¶
func (s ListProjectsOutput) String() string
String returns the string representation
type ListProjectsRequest ¶
type ListProjectsRequest struct { *aws.Request Input *ListProjectsInput Copy func(*ListProjectsInput) ListProjectsRequest }
ListProjectsRequest is a API request type for the ListProjects API operation.
func (ListProjectsRequest) Send ¶
func (r ListProjectsRequest) Send() (*ListProjectsOutput, error)
Send marshals and sends the ListProjects API 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" timestampFormat:"unix" 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" timestampFormat:"unix" 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) GoString ¶
func (s PlacementDescription) GoString() string
GoString returns the string representation
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" timestampFormat:"unix" 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" timestampFormat:"unix" 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) GoString ¶
func (s PlacementSummary) GoString() string
GoString returns the string representation
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) GoString ¶
func (s PlacementTemplate) GoString() string
GoString returns the string representation
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 date when the project was originally created, in UNIX epoch time format. // // CreatedDate is a required field CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix" 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 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" timestampFormat:"unix" 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) GoString ¶
func (s ProjectDescription) GoString() string
GoString returns the string representation
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 date when the project was originally created, in UNIX epoch time format. // // CreatedDate is a required field CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix" 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 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" timestampFormat:"unix" 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) GoString ¶
func (s ProjectSummary) GoString() string
GoString returns the string representation
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 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) GoString ¶
func (s UpdatePlacementInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s UpdatePlacementOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s UpdatePlacementOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the UpdatePlacement API operation.
func (UpdatePlacementRequest) Send ¶
func (r UpdatePlacementRequest) Send() (*UpdatePlacementOutput, error)
Send marshals and sends the UpdatePlacement API 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) GoString ¶
func (s UpdateProjectInput) GoString() string
GoString returns the string representation
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) GoString ¶
func (s UpdateProjectOutput) GoString() string
GoString returns the string representation
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) SDKResponseMetadata ¶
func (s UpdateProjectOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
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 a API request type for the UpdateProject API operation.
func (UpdateProjectRequest) Send ¶
func (r UpdateProjectRequest) Send() (*UpdateProjectOutput, error)
Send marshals and sends the UpdateProject API request.
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. |