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.CreateApplication

Description

Creates an application, optionally including an AWS SAM file to create the first application version in the same call.

Synopsis

Creating a Request

data CreateApplication Source #

See: newCreateApplication smart constructor.

Constructors

CreateApplication' 

Fields

  • 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+\\-_:\\/@]+$";

  • licenseBody :: Maybe Text

    A local text file that contains the license of the app that matches the spdxLicenseID value of your application. The file has the format file://<path>/<filename>.

    Maximum size 5 MB

    You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

  • licenseUrl :: Maybe Text

    A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

  • readmeBody :: Maybe Text

    A local text readme file in Markdown language that contains a more detailed description of the application and how it works. The file has the format file://<path>/<filename>.

    Maximum size 5 MB

    You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

  • readmeUrl :: Maybe Text

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

    Maximum size 5 MB

    You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

  • semanticVersion :: Maybe Text

    The semantic version of the application:

    https://semver.org/

  • sourceCodeArchiveUrl :: Maybe Text

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

  • sourceCodeUrl :: Maybe Text

    A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

  • spdxLicenseId :: Maybe Text

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

  • templateBody :: Maybe Text

    The local raw packaged AWS SAM template file of your application. The file has the format file://<path>/<filename>.

    You can specify only one of templateBody and templateUrl; otherwise an error results.

  • templateUrl :: Maybe Text

    A link to the S3 object containing the packaged AWS SAM template of your application.

    You can specify only one of templateBody and templateUrl; otherwise an error results.

  • description :: Text

    The description of the application.

    Minimum length=1. Maximum length=256

  • name :: Text

    The name of the application that you want to publish.

    Minimum length=1. Maximum length=140

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

  • author :: 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])?$";

Instances

Instances details
ToJSON CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

ToHeaders CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

ToPath CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

ToQuery CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

AWSRequest CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

Associated Types

type AWSResponse CreateApplication #

Generic CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

Associated Types

type Rep CreateApplication :: Type -> Type #

Read CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

Show CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

NFData CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

Methods

rnf :: CreateApplication -> () #

Eq CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

Hashable CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

type AWSResponse CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

type Rep CreateApplication Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

type Rep CreateApplication = D1 ('MetaData "CreateApplication" "Amazonka.ServerlessApplicationRepository.CreateApplication" "amazonka-serverlessrepo-2.0-DJX7EnU3zce9dFmCiMzat7" 'False) (C1 ('MetaCons "CreateApplication'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "homePageUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "labels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "licenseBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "licenseUrl") '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 "semanticVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "sourceCodeArchiveUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceCodeUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "spdxLicenseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "templateUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateApplication Source #

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

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

CreateApplication, createApplication_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:licenseBody:CreateApplication', createApplication_licenseBody - A local text file that contains the license of the app that matches the spdxLicenseID value of your application. The file has the format file://<path>/<filename>.

Maximum size 5 MB

You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

CreateApplication, createApplication_licenseUrl - A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.

Maximum size 5 MB

You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

$sel:readmeBody:CreateApplication', createApplication_readmeBody - A local text readme file in Markdown language that contains a more detailed description of the application and how it works. The file has the format file://<path>/<filename>.

Maximum size 5 MB

You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

CreateApplication, createApplication_readmeUrl - A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.

Maximum size 5 MB

You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

CreateApplication, createApplication_semanticVersion - The semantic version of the application:

https://semver.org/

CreateApplication, createApplication_sourceCodeArchiveUrl - A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

Maximum size 50 MB

CreateApplication, createApplication_sourceCodeUrl - A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

CreateApplication, createApplication_spdxLicenseId - A valid identifier from https://spdx.org/licenses/.

$sel:templateBody:CreateApplication', createApplication_templateBody - The local raw packaged AWS SAM template file of your application. The file has the format file://<path>/<filename>.

You can specify only one of templateBody and templateUrl; otherwise an error results.

CreateApplication, createApplication_templateUrl - A link to the S3 object containing the packaged AWS SAM template of your application.

You can specify only one of templateBody and templateUrl; otherwise an error results.

CreateApplication, createApplication_description - The description of the application.

Minimum length=1. Maximum length=256

CreateApplication, createApplication_name - The name of the application that you want to publish.

Minimum length=1. Maximum length=140

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

CreateApplication, createApplication_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])?$";

Request Lenses

createApplication_homePageUrl :: Lens' CreateApplication (Maybe Text) Source #

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

createApplication_labels :: Lens' CreateApplication (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+\\-_:\\/@]+$";

createApplication_licenseBody :: Lens' CreateApplication (Maybe Text) Source #

A local text file that contains the license of the app that matches the spdxLicenseID value of your application. The file has the format file://<path>/<filename>.

Maximum size 5 MB

You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

createApplication_licenseUrl :: Lens' CreateApplication (Maybe Text) Source #

A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.

Maximum size 5 MB

You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

createApplication_readmeBody :: Lens' CreateApplication (Maybe Text) Source #

A local text readme file in Markdown language that contains a more detailed description of the application and how it works. The file has the format file://<path>/<filename>.

Maximum size 5 MB

You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

createApplication_readmeUrl :: Lens' CreateApplication (Maybe Text) Source #

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

Maximum size 5 MB

You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

createApplication_sourceCodeArchiveUrl :: Lens' CreateApplication (Maybe Text) Source #

A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

Maximum size 50 MB

createApplication_sourceCodeUrl :: Lens' CreateApplication (Maybe Text) Source #

A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

createApplication_templateBody :: Lens' CreateApplication (Maybe Text) Source #

The local raw packaged AWS SAM template file of your application. The file has the format file://<path>/<filename>.

You can specify only one of templateBody and templateUrl; otherwise an error results.

createApplication_templateUrl :: Lens' CreateApplication (Maybe Text) Source #

A link to the S3 object containing the packaged AWS SAM template of your application.

You can specify only one of templateBody and templateUrl; otherwise an error results.

createApplication_description :: Lens' CreateApplication Text Source #

The description of the application.

Minimum length=1. Maximum length=256

createApplication_name :: Lens' CreateApplication Text Source #

The name of the application that you want to publish.

Minimum length=1. Maximum length=140

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

createApplication_author :: Lens' CreateApplication 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])?$";

Destructuring the Response

data CreateApplicationResponse Source #

See: newCreateApplicationResponse smart constructor.

Constructors

CreateApplicationResponse' 

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 CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

Associated Types

type Rep CreateApplicationResponse :: Type -> Type #

Read CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

Show CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

NFData CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

Eq CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

type Rep CreateApplicationResponse Source # 
Instance details

Defined in Amazonka.ServerlessApplicationRepository.CreateApplication

type Rep CreateApplicationResponse = D1 ('MetaData "CreateApplicationResponse" "Amazonka.ServerlessApplicationRepository.CreateApplication" "amazonka-serverlessrepo-2.0-DJX7EnU3zce9dFmCiMzat7" 'False) (C1 ('MetaCons "CreateApplicationResponse'" '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))))))

newCreateApplicationResponse Source #

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

CreateApplicationResponse, createApplicationResponse_applicationId - The application Amazon Resource Name (ARN).

CreateApplication, createApplicationResponse_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])?$";

CreateApplicationResponse, createApplicationResponse_creationTime - The date and time this resource was created.

CreateApplication, createApplicationResponse_description - The description of the application.

Minimum length=1. Maximum length=256

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

$sel:isVerifiedAuthor:CreateApplicationResponse', createApplicationResponse_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.

CreateApplication, createApplicationResponse_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+\\-_:\\/@]+$";

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

Maximum size 5 MB

CreateApplication, createApplicationResponse_name - The name of the application.

Minimum length=1. Maximum length=140

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

CreateApplication, createApplicationResponse_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

CreateApplication, createApplicationResponse_spdxLicenseId - A valid identifier from https://spdx.org/licenses/.

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

$sel:version:CreateApplicationResponse', createApplicationResponse_version - Version information about the application.

$sel:httpStatus:CreateApplicationResponse', createApplicationResponse_httpStatus - The response's http status code.

Response Lenses

createApplicationResponse_author :: Lens' CreateApplicationResponse (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])?$";

createApplicationResponse_description :: Lens' CreateApplicationResponse (Maybe Text) Source #

The description of the application.

Minimum length=1. Maximum length=256

createApplicationResponse_homePageUrl :: Lens' CreateApplicationResponse (Maybe Text) Source #

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

createApplicationResponse_isVerifiedAuthor :: Lens' CreateApplicationResponse (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.

createApplicationResponse_labels :: Lens' CreateApplicationResponse (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+\\-_:\\/@]+$";

createApplicationResponse_licenseUrl :: Lens' CreateApplicationResponse (Maybe Text) Source #

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

Maximum size 5 MB

createApplicationResponse_name :: Lens' CreateApplicationResponse (Maybe Text) Source #

The name of the application.

Minimum length=1. Maximum length=140

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

createApplicationResponse_readmeUrl :: Lens' CreateApplicationResponse (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

createApplicationResponse_spdxLicenseId :: Lens' CreateApplicationResponse (Maybe Text) Source #

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

createApplicationResponse_verifiedAuthorUrl :: Lens' CreateApplicationResponse (Maybe Text) Source #

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