amazonka-servicecatalog-2.0: Amazon Service Catalog 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.ServiceCatalog.UpdateProvisioningArtifact

Description

Updates the specified provisioning artifact (also known as a version) for the specified product.

You cannot update a provisioning artifact for a product that was shared with you.

Synopsis

Creating a Request

data UpdateProvisioningArtifact Source #

See: newUpdateProvisioningArtifact smart constructor.

Constructors

UpdateProvisioningArtifact' 

Fields

  • acceptLanguage :: Maybe Text

    The language code.

    • en - English (default)
    • jp - Japanese
    • zh - Chinese
  • active :: Maybe Bool

    Indicates whether the product version is active.

    Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

  • description :: Maybe Text

    The updated description of the provisioning artifact.

  • guidance :: Maybe ProvisioningArtifactGuidance

    Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

    The DEFAULT value indicates that the product version is active.

    The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

  • name :: Maybe Text

    The updated name of the provisioning artifact.

  • productId :: Text

    The product identifier.

  • provisioningArtifactId :: Text

    The identifier of the provisioning artifact.

Instances

Instances details
ToJSON UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

ToHeaders UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

ToPath UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

ToQuery UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

AWSRequest UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

Generic UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

Associated Types

type Rep UpdateProvisioningArtifact :: Type -> Type #

Read UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

Show UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

NFData UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

Eq UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

Hashable UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

type AWSResponse UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

type Rep UpdateProvisioningArtifact Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

type Rep UpdateProvisioningArtifact = D1 ('MetaData "UpdateProvisioningArtifact" "Amazonka.ServiceCatalog.UpdateProvisioningArtifact" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "UpdateProvisioningArtifact'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "active") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "guidance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisioningArtifactGuidance)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "productId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "provisioningArtifactId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateProvisioningArtifact Source #

Create a value of UpdateProvisioningArtifact 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:acceptLanguage:UpdateProvisioningArtifact', updateProvisioningArtifact_acceptLanguage - The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese

UpdateProvisioningArtifact, updateProvisioningArtifact_active - Indicates whether the product version is active.

Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

UpdateProvisioningArtifact, updateProvisioningArtifact_description - The updated description of the provisioning artifact.

UpdateProvisioningArtifact, updateProvisioningArtifact_guidance - Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

The DEFAULT value indicates that the product version is active.

The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

UpdateProvisioningArtifact, updateProvisioningArtifact_name - The updated name of the provisioning artifact.

UpdateProvisioningArtifact, updateProvisioningArtifact_productId - The product identifier.

UpdateProvisioningArtifact, updateProvisioningArtifact_provisioningArtifactId - The identifier of the provisioning artifact.

Request Lenses

updateProvisioningArtifact_acceptLanguage :: Lens' UpdateProvisioningArtifact (Maybe Text) Source #

The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese

updateProvisioningArtifact_active :: Lens' UpdateProvisioningArtifact (Maybe Bool) Source #

Indicates whether the product version is active.

Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.

updateProvisioningArtifact_description :: Lens' UpdateProvisioningArtifact (Maybe Text) Source #

The updated description of the provisioning artifact.

updateProvisioningArtifact_guidance :: Lens' UpdateProvisioningArtifact (Maybe ProvisioningArtifactGuidance) Source #

Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

The DEFAULT value indicates that the product version is active.

The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

updateProvisioningArtifact_name :: Lens' UpdateProvisioningArtifact (Maybe Text) Source #

The updated name of the provisioning artifact.

Destructuring the Response

data UpdateProvisioningArtifactResponse Source #

Constructors

UpdateProvisioningArtifactResponse' 

Fields

Instances

Instances details
Generic UpdateProvisioningArtifactResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

Associated Types

type Rep UpdateProvisioningArtifactResponse :: Type -> Type #

Read UpdateProvisioningArtifactResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

Show UpdateProvisioningArtifactResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

NFData UpdateProvisioningArtifactResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

Eq UpdateProvisioningArtifactResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

type Rep UpdateProvisioningArtifactResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.UpdateProvisioningArtifact

type Rep UpdateProvisioningArtifactResponse = D1 ('MetaData "UpdateProvisioningArtifactResponse" "Amazonka.ServiceCatalog.UpdateProvisioningArtifact" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "UpdateProvisioningArtifactResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "info") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "provisioningArtifactDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisioningArtifactDetail))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateProvisioningArtifactResponse Source #

Create a value of UpdateProvisioningArtifactResponse 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:

UpdateProvisioningArtifactResponse, updateProvisioningArtifactResponse_info - The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.

$sel:provisioningArtifactDetail:UpdateProvisioningArtifactResponse', updateProvisioningArtifactResponse_provisioningArtifactDetail - Information about the provisioning artifact.

UpdateProvisioningArtifactResponse, updateProvisioningArtifactResponse_status - The status of the current request.

$sel:httpStatus:UpdateProvisioningArtifactResponse', updateProvisioningArtifactResponse_httpStatus - The response's http status code.

Response Lenses

updateProvisioningArtifactResponse_info :: Lens' UpdateProvisioningArtifactResponse (Maybe (HashMap Text Text)) Source #

The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.