amazonka-iot1click-projects-2.0: Amazon IoT 1-Click Projects Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT1ClickProjects.UpdateProject

Description

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., "").

Synopsis

Creating a Request

data UpdateProject Source #

See: newUpdateProject smart constructor.

Constructors

UpdateProject' 

Fields

  • description :: Maybe Text

    An optional user-defined description for the project.

  • placementTemplate :: Maybe PlacementTemplate

    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.

  • projectName :: Text

    The name of the project to be updated.

Instances

Instances details
ToJSON UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

ToHeaders UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

ToPath UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

ToQuery UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

AWSRequest UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

Associated Types

type AWSResponse UpdateProject #

Generic UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

Associated Types

type Rep UpdateProject :: Type -> Type #

Read UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

Show UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

NFData UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

Methods

rnf :: UpdateProject -> () #

Eq UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

Hashable UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

type AWSResponse UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

type Rep UpdateProject Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

type Rep UpdateProject = D1 ('MetaData "UpdateProject" "Amazonka.IoT1ClickProjects.UpdateProject" "amazonka-iot1click-projects-2.0-KLltusBcTZO1f6G5pKsT1G" 'False) (C1 ('MetaCons "UpdateProject'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "placementTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PlacementTemplate)) :*: S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateProject Source #

Create a value of UpdateProject with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateProject, updateProject_description - An optional user-defined description for the project.

UpdateProject, updateProject_placementTemplate - 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.

UpdateProject, updateProject_projectName - The name of the project to be updated.

Request Lenses

updateProject_description :: Lens' UpdateProject (Maybe Text) Source #

An optional user-defined description for the project.

updateProject_placementTemplate :: Lens' UpdateProject (Maybe PlacementTemplate) Source #

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.

updateProject_projectName :: Lens' UpdateProject Text Source #

The name of the project to be updated.

Destructuring the Response

data UpdateProjectResponse Source #

See: newUpdateProjectResponse smart constructor.

Constructors

UpdateProjectResponse' 

Fields

Instances

Instances details
Generic UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

Associated Types

type Rep UpdateProjectResponse :: Type -> Type #

Read UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

Show UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

NFData UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

Methods

rnf :: UpdateProjectResponse -> () #

Eq UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

type Rep UpdateProjectResponse Source # 
Instance details

Defined in Amazonka.IoT1ClickProjects.UpdateProject

type Rep UpdateProjectResponse = D1 ('MetaData "UpdateProjectResponse" "Amazonka.IoT1ClickProjects.UpdateProject" "amazonka-iot1click-projects-2.0-KLltusBcTZO1f6G5pKsT1G" 'False) (C1 ('MetaCons "UpdateProjectResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateProjectResponse Source #

Create a value of UpdateProjectResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:UpdateProjectResponse', updateProjectResponse_httpStatus - The response's http status code.

Response Lenses