amazonka-serverlessrepo-2.0: Amazon ServerlessApplicationRepository 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.ServerlessApplicationRepository.UpdateApplication

Description

Updates the specified application.

Synopsis

Creating a Request

data UpdateApplication Source #

See: newUpdateApplication smart constructor.

Constructors

UpdateApplication' 

Fields

  • author :: Maybe Text

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

  • description :: Maybe Text

    The description of the application.

    Minimum length=1. Maximum length=256

  • homePageUrl :: Maybe Text

    A URL with more information about the application, for example the location of your GitHub repository for the application.

  • labels :: Maybe [Text]

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

  • readmeBody :: Maybe Text

    A text readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

  • readmeUrl :: Maybe Text

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

  • applicationId :: Text

    The Amazon Resource Name (ARN) of the application.

Instances

Instances details
ToJSON UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

ToHeaders UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

ToPath UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

ToQuery UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

AWSRequest UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

Associated Types

type AWSResponse UpdateApplication #

Generic UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

Associated Types

type Rep UpdateApplication :: Type -> Type #

Read UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

Show UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

NFData UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

Methods

rnf :: UpdateApplication -> () #

Eq UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

Hashable UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

type AWSResponse UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

type Rep UpdateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

type Rep UpdateApplication = D1 ('MetaData "UpdateApplication" "Amazonka.ServerlessApplicationRepository.UpdateApplication" "amazonka-serverlessrepo-2.0-DJX7EnU3zce9dFmCiMzat7" 'False) (C1 ('MetaCons "UpdateApplication'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "homePageUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "labels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "readmeBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "readmeUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateApplication Source #

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

UpdateApplication, updateApplication_author - The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

UpdateApplication, updateApplication_description - The description of the application.

Minimum length=1. Maximum length=256

UpdateApplication, updateApplication_homePageUrl - A URL with more information about the application, for example the location of your GitHub repository for the application.

UpdateApplication, updateApplication_labels - Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

$sel:readmeBody:UpdateApplication', updateApplication_readmeBody - A text readme file in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

UpdateApplication, updateApplication_readmeUrl - A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

UpdateApplication, updateApplication_applicationId - The Amazon Resource Name (ARN) of the application.

Request Lenses

updateApplication_author :: Lens' UpdateApplication (Maybe Text) Source #

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

updateApplication_description :: Lens' UpdateApplication (Maybe Text) Source #

The description of the application.

Minimum length=1. Maximum length=256

updateApplication_homePageUrl :: Lens' UpdateApplication (Maybe Text) Source #

A URL with more information about the application, for example the location of your GitHub repository for the application.

updateApplication_labels :: Lens' UpdateApplication (Maybe [Text]) Source #

Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

updateApplication_readmeBody :: Lens' UpdateApplication (Maybe Text) Source #

A text readme file in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

updateApplication_readmeUrl :: Lens' UpdateApplication (Maybe Text) Source #

A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

updateApplication_applicationId :: Lens' UpdateApplication Text Source #

The Amazon Resource Name (ARN) of the application.

Destructuring the Response

data UpdateApplicationResponse Source #

See: newUpdateApplicationResponse smart constructor.

Constructors

UpdateApplicationResponse' 

Fields

  • applicationId :: Maybe Text

    The application Amazon Resource Name (ARN).

  • author :: Maybe Text

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

  • creationTime :: Maybe Text

    The date and time this resource was created.

  • description :: Maybe Text

    The description of the application.

    Minimum length=1. Maximum length=256

  • homePageUrl :: Maybe Text

    A URL with more information about the application, for example the location of your GitHub repository for the application.

  • isVerifiedAuthor :: Maybe Bool

    Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.

  • labels :: Maybe [Text]

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

  • licenseUrl :: Maybe Text

    A link to a license file of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

  • name :: Maybe Text

    The name of the application.

    Minimum length=1. Maximum length=140

    Pattern: "[a-zA-Z0-9\\-]+";

  • readmeUrl :: Maybe Text

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

  • spdxLicenseId :: Maybe Text

    A valid identifier from https://spdx.org/licenses/.

  • verifiedAuthorUrl :: Maybe Text

    The URL to the public profile of a verified author. This URL is submitted by the author.

  • version :: Maybe Version

    Version information about the application.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UpdateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

Associated Types

type Rep UpdateApplicationResponse :: Type -> Type #

Read UpdateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

Show UpdateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

NFData UpdateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

Eq UpdateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

type Rep UpdateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.UpdateApplication

type Rep UpdateApplicationResponse = D1 ('MetaData "UpdateApplicationResponse" "Amazonka.ServerlessApplicationRepository.UpdateApplication" "amazonka-serverlessrepo-2.0-DJX7EnU3zce9dFmCiMzat7" 'False) (C1 ('MetaCons "UpdateApplicationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "homePageUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "isVerifiedAuthor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "labels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "licenseUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "readmeUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "spdxLicenseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "verifiedAuthorUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Version)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUpdateApplicationResponse Source #

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

UpdateApplication, updateApplicationResponse_applicationId - The application Amazon Resource Name (ARN).

UpdateApplication, updateApplicationResponse_author - The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

UpdateApplicationResponse, updateApplicationResponse_creationTime - The date and time this resource was created.

UpdateApplication, updateApplicationResponse_description - The description of the application.

Minimum length=1. Maximum length=256

UpdateApplication, updateApplicationResponse_homePageUrl - A URL with more information about the application, for example the location of your GitHub repository for the application.

$sel:isVerifiedAuthor:UpdateApplicationResponse', updateApplicationResponse_isVerifiedAuthor - Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.

UpdateApplication, updateApplicationResponse_labels - Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

$sel:licenseUrl:UpdateApplicationResponse', updateApplicationResponse_licenseUrl - A link to a license file of the app that matches the spdxLicenseID value of your application.

Maximum size 5 MB

UpdateApplicationResponse, updateApplicationResponse_name - The name of the application.

Minimum length=1. Maximum length=140

Pattern: "[a-zA-Z0-9\\-]+";

UpdateApplication, updateApplicationResponse_readmeUrl - A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

UpdateApplicationResponse, updateApplicationResponse_spdxLicenseId - A valid identifier from https://spdx.org/licenses/.

$sel:verifiedAuthorUrl:UpdateApplicationResponse', updateApplicationResponse_verifiedAuthorUrl - The URL to the public profile of a verified author. This URL is submitted by the author.

$sel:version:UpdateApplicationResponse', updateApplicationResponse_version - Version information about the application.

$sel:httpStatus:UpdateApplicationResponse', updateApplicationResponse_httpStatus - The response's http status code.

Response Lenses

updateApplicationResponse_author :: Lens' UpdateApplicationResponse (Maybe Text) Source #

The name of the author publishing the app.

Minimum length=1. Maximum length=127.

Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";

updateApplicationResponse_description :: Lens' UpdateApplicationResponse (Maybe Text) Source #

The description of the application.

Minimum length=1. Maximum length=256

updateApplicationResponse_homePageUrl :: Lens' UpdateApplicationResponse (Maybe Text) Source #

A URL with more information about the application, for example the location of your GitHub repository for the application.

updateApplicationResponse_isVerifiedAuthor :: Lens' UpdateApplicationResponse (Maybe Bool) Source #

Whether the author of this application has been verified. This means means that AWS has made a good faith review, as a reasonable and prudent service provider, of the information provided by the requester and has confirmed that the requester's identity is as claimed.

updateApplicationResponse_labels :: Lens' UpdateApplicationResponse (Maybe [Text]) Source #

Labels to improve discovery of apps in search results.

Minimum length=1. Maximum length=127. Maximum number of labels: 10

Pattern: "^[a-zA-Z0-9+\\-_:\\/@]+$";

updateApplicationResponse_licenseUrl :: Lens' UpdateApplicationResponse (Maybe Text) Source #

A link to a license file of the app that matches the spdxLicenseID value of your application.

Maximum size 5 MB

updateApplicationResponse_name :: Lens' UpdateApplicationResponse (Maybe Text) Source #

The name of the application.

Minimum length=1. Maximum length=140

Pattern: "[a-zA-Z0-9\\-]+";

updateApplicationResponse_readmeUrl :: Lens' UpdateApplicationResponse (Maybe Text) Source #

A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

updateApplicationResponse_spdxLicenseId :: Lens' UpdateApplicationResponse (Maybe Text) Source #

A valid identifier from https://spdx.org/licenses/.

updateApplicationResponse_verifiedAuthorUrl :: Lens' UpdateApplicationResponse (Maybe Text) Source #

The URL to the public profile of a verified author. This URL is submitted by the author.