Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Creates an application, optionally including an AWS SAM file to create the first application version in the same call.
Synopsis
- data CreateApplication = CreateApplication' {
- homePageUrl :: Maybe Text
- readmeBody :: Maybe Text
- licenseUrl :: Maybe Text
- semanticVersion :: Maybe Text
- sourceCodeUrl :: Maybe Text
- readmeUrl :: Maybe Text
- labels :: Maybe [Text]
- templateBody :: Maybe Text
- templateUrl :: Maybe Text
- licenseBody :: Maybe Text
- spdxLicenseId :: Maybe Text
- sourceCodeArchiveUrl :: Maybe Text
- description :: Text
- name :: Text
- author :: Text
- newCreateApplication :: Text -> Text -> Text -> CreateApplication
- createApplication_homePageUrl :: Lens' CreateApplication (Maybe Text)
- createApplication_readmeBody :: Lens' CreateApplication (Maybe Text)
- createApplication_licenseUrl :: Lens' CreateApplication (Maybe Text)
- createApplication_semanticVersion :: Lens' CreateApplication (Maybe Text)
- createApplication_sourceCodeUrl :: Lens' CreateApplication (Maybe Text)
- createApplication_readmeUrl :: Lens' CreateApplication (Maybe Text)
- createApplication_labels :: Lens' CreateApplication (Maybe [Text])
- createApplication_templateBody :: Lens' CreateApplication (Maybe Text)
- createApplication_templateUrl :: Lens' CreateApplication (Maybe Text)
- createApplication_licenseBody :: Lens' CreateApplication (Maybe Text)
- createApplication_spdxLicenseId :: Lens' CreateApplication (Maybe Text)
- createApplication_sourceCodeArchiveUrl :: Lens' CreateApplication (Maybe Text)
- createApplication_description :: Lens' CreateApplication Text
- createApplication_name :: Lens' CreateApplication Text
- createApplication_author :: Lens' CreateApplication Text
- data CreateApplicationResponse = CreateApplicationResponse' {
- creationTime :: Maybe Text
- homePageUrl :: Maybe Text
- licenseUrl :: Maybe Text
- readmeUrl :: Maybe Text
- applicationId :: Maybe Text
- name :: Maybe Text
- version :: Maybe Version
- author :: Maybe Text
- labels :: Maybe [Text]
- verifiedAuthorUrl :: Maybe Text
- description :: Maybe Text
- spdxLicenseId :: Maybe Text
- isVerifiedAuthor :: Maybe Bool
- httpStatus :: Int
- newCreateApplicationResponse :: Int -> CreateApplicationResponse
- createApplicationResponse_creationTime :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_homePageUrl :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_licenseUrl :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_readmeUrl :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_applicationId :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_name :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_version :: Lens' CreateApplicationResponse (Maybe Version)
- createApplicationResponse_author :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_labels :: Lens' CreateApplicationResponse (Maybe [Text])
- createApplicationResponse_verifiedAuthorUrl :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_description :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_spdxLicenseId :: Lens' CreateApplicationResponse (Maybe Text)
- createApplicationResponse_isVerifiedAuthor :: Lens' CreateApplicationResponse (Maybe Bool)
- createApplicationResponse_httpStatus :: Lens' CreateApplicationResponse Int
Creating a Request
data CreateApplication Source #
See: newCreateApplication
smart constructor.
CreateApplication' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> CreateApplication |
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:
$sel:homePageUrl:CreateApplication'
, createApplication_homePageUrl
- A URL with more information about the application, for example the
location of your GitHub repository for the application.
$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.
$sel:licenseUrl: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:semanticVersion:CreateApplication'
, createApplication_semanticVersion
- The semantic version of the application:
$sel:sourceCodeUrl: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.
$sel:readmeUrl: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.
$sel:labels: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: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.
$sel:templateUrl: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.
$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.
$sel:spdxLicenseId:CreateApplication'
, createApplication_spdxLicenseId
- A valid identifier from https://spdx.org/licenses/.
$sel:sourceCodeArchiveUrl: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
$sel:description:CreateApplication'
, createApplication_description
- The description of the application.
Minimum length=1. Maximum length=256
$sel:name:CreateApplication'
, createApplication_name
- The name of the application that you want to publish.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
$sel:author: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_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_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_semanticVersion :: Lens' CreateApplication (Maybe Text) Source #
The semantic version of the application:
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_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_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_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_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_spdxLicenseId :: Lens' CreateApplication (Maybe Text) Source #
A valid identifier from https://spdx.org/licenses/.
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_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.
CreateApplicationResponse' | |
|
Instances
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:
$sel:creationTime:CreateApplicationResponse'
, createApplicationResponse_creationTime
- The date and time this resource was created.
$sel:homePageUrl:CreateApplication'
, createApplicationResponse_homePageUrl
- A URL with more information about the application, for example the
location of your GitHub repository for the application.
$sel:licenseUrl:CreateApplication'
, createApplicationResponse_licenseUrl
- A link to a license file of the app that matches the spdxLicenseID value
of your application.
Maximum size 5 MB
$sel:readmeUrl: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
$sel:applicationId:CreateApplicationResponse'
, createApplicationResponse_applicationId
- The application Amazon Resource Name (ARN).
$sel:name:CreateApplication'
, createApplicationResponse_name
- The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
$sel:version:CreateApplicationResponse'
, createApplicationResponse_version
- Version information about the application.
$sel:author: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])?$";
$sel:labels: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+\\-_:\\/@]+$";
$sel:verifiedAuthorUrl:CreateApplicationResponse'
, createApplicationResponse_verifiedAuthorUrl
- The URL to the public profile of a verified author. This URL is
submitted by the author.
$sel:description:CreateApplication'
, createApplicationResponse_description
- The description of the application.
Minimum length=1. Maximum length=256
$sel:spdxLicenseId:CreateApplication'
, createApplicationResponse_spdxLicenseId
- A valid identifier from https://spdx.org/licenses/.
$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.
$sel:httpStatus:CreateApplicationResponse'
, createApplicationResponse_httpStatus
- The response's http status code.
Response Lenses
createApplicationResponse_creationTime :: Lens' CreateApplicationResponse (Maybe Text) Source #
The date and time this resource was created.
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_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_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_applicationId :: Lens' CreateApplicationResponse (Maybe Text) Source #
The application Amazon Resource Name (ARN).
createApplicationResponse_name :: Lens' CreateApplicationResponse (Maybe Text) Source #
The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
createApplicationResponse_version :: Lens' CreateApplicationResponse (Maybe Version) Source #
Version information about the application.
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_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_verifiedAuthorUrl :: Lens' CreateApplicationResponse (Maybe Text) Source #
The URL to the public profile of a verified author. This URL is submitted by the author.
createApplicationResponse_description :: Lens' CreateApplicationResponse (Maybe Text) Source #
The description of the application.
Minimum length=1. Maximum length=256
createApplicationResponse_spdxLicenseId :: Lens' CreateApplicationResponse (Maybe Text) Source #
A valid identifier from https://spdx.org/licenses/.
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_httpStatus :: Lens' CreateApplicationResponse Int Source #
The response's http status code.