| 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 |
Amazonka.ServerlessApplicationRepository
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- GetApplicationPolicy
- CreateApplicationVersion
- UnshareApplication
- DeleteApplication
- UpdateApplication
- CreateCloudFormationTemplate
- CreateApplication
- ListApplicationDependencies (Paginated)
- ListApplicationVersions (Paginated)
- GetApplication
- GetCloudFormationTemplate
- CreateCloudFormationChangeSet
- PutApplicationPolicy
- ListApplications (Paginated)
- Types
Description
Derived from API version 2017-09-08 of the AWS service descriptions, licensed under Apache 2.0.
The AWS Serverless Application Repository makes it easy for developers and enterprises to quickly find and deploy serverless applications in the AWS Cloud. For more information about serverless applications, see Serverless Computing and Applications on the AWS website.
The AWS Serverless Application Repository is deeply integrated with the AWS Lambda console, so that developers of all levels can get started with serverless computing without needing to learn anything new. You can use category keywords to browse for applications such as web and mobile backends, data processing applications, or chatbots. You can also search for applications by name, publisher, or event source. To use an application, you simply choose it, configure any required fields, and deploy it with a few clicks.
You can also easily publish applications, sharing them publicly with the community at large, or privately within your team or across your organization. To publish a serverless application (or app), you can use the AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS SDKs to upload the code. Along with the code, you upload a simple manifest file, also known as the AWS Serverless Application Model (AWS SAM) template. For more information about AWS SAM, see AWS Serverless Application Model (AWS SAM) on the AWS Labs GitHub repository.
The AWS Serverless Application Repository Developer Guide contains more information about the two developer experiences available:
Consuming Applications – Browse for applications and view information about them, including source code and readme files. Also install, configure, and deploy applications of your choosing.
Publishing Applications – Configure and upload applications to make them available to other developers, and publish new versions of applications.
Synopsis
- defaultService :: Service
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- data GetApplicationPolicy = GetApplicationPolicy' Text
- newGetApplicationPolicy :: Text -> GetApplicationPolicy
- data GetApplicationPolicyResponse = GetApplicationPolicyResponse' (Maybe [ApplicationPolicyStatement]) Int
- newGetApplicationPolicyResponse :: Int -> GetApplicationPolicyResponse
- data CreateApplicationVersion = CreateApplicationVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newCreateApplicationVersion :: Text -> Text -> CreateApplicationVersion
- data CreateApplicationVersionResponse = CreateApplicationVersionResponse' (Maybe Text) (Maybe Bool) (Maybe [Capability]) (Maybe [ParameterDefinition]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateApplicationVersionResponse :: Int -> CreateApplicationVersionResponse
- data UnshareApplication = UnshareApplication' Text Text
- newUnshareApplication :: Text -> Text -> UnshareApplication
- data UnshareApplicationResponse = UnshareApplicationResponse' {
- newUnshareApplicationResponse :: UnshareApplicationResponse
- data DeleteApplication = DeleteApplication' Text
- newDeleteApplication :: Text -> DeleteApplication
- data DeleteApplicationResponse = DeleteApplicationResponse' {
- newDeleteApplicationResponse :: DeleteApplicationResponse
- data UpdateApplication = UpdateApplication' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) Text
- newUpdateApplication :: Text -> UpdateApplication
- data UpdateApplicationResponse = UpdateApplicationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Version) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) Int
- newUpdateApplicationResponse :: Int -> UpdateApplicationResponse
- data CreateCloudFormationTemplate = CreateCloudFormationTemplate' (Maybe Text) Text
- newCreateCloudFormationTemplate :: Text -> CreateCloudFormationTemplate
- data CreateCloudFormationTemplateResponse = CreateCloudFormationTemplateResponse' (Maybe Text) (Maybe Status) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateCloudFormationTemplateResponse :: Int -> CreateCloudFormationTemplateResponse
- data CreateApplication = CreateApplication' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text
- newCreateApplication :: Text -> Text -> Text -> CreateApplication
- data CreateApplicationResponse = CreateApplicationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Version) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) Int
- newCreateApplicationResponse :: Int -> CreateApplicationResponse
- data ListApplicationDependencies = ListApplicationDependencies' (Maybe Text) (Maybe Text) (Maybe Natural) Text
- newListApplicationDependencies :: Text -> ListApplicationDependencies
- data ListApplicationDependenciesResponse = ListApplicationDependenciesResponse' (Maybe [ApplicationDependencySummary]) (Maybe Text) Int
- newListApplicationDependenciesResponse :: Int -> ListApplicationDependenciesResponse
- data ListApplicationVersions = ListApplicationVersions' (Maybe Text) (Maybe Natural) Text
- newListApplicationVersions :: Text -> ListApplicationVersions
- data ListApplicationVersionsResponse = ListApplicationVersionsResponse' (Maybe [VersionSummary]) (Maybe Text) Int
- newListApplicationVersionsResponse :: Int -> ListApplicationVersionsResponse
- data GetApplication = GetApplication' (Maybe Text) Text
- newGetApplication :: Text -> GetApplication
- data GetApplicationResponse = GetApplicationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Version) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) Int
- newGetApplicationResponse :: Int -> GetApplicationResponse
- data GetCloudFormationTemplate = GetCloudFormationTemplate' Text Text
- newGetCloudFormationTemplate :: Text -> Text -> GetCloudFormationTemplate
- data GetCloudFormationTemplateResponse = GetCloudFormationTemplateResponse' (Maybe Text) (Maybe Status) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetCloudFormationTemplateResponse :: Int -> GetCloudFormationTemplateResponse
- data CreateCloudFormationChangeSet = CreateCloudFormationChangeSet' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [ParameterValue]) (Maybe RollbackConfiguration) (Maybe [Text]) (Maybe [Tag]) Text Text
- newCreateCloudFormationChangeSet :: Text -> Text -> CreateCloudFormationChangeSet
- data CreateCloudFormationChangeSetResponse = CreateCloudFormationChangeSetResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateCloudFormationChangeSetResponse :: Int -> CreateCloudFormationChangeSetResponse
- data PutApplicationPolicy = PutApplicationPolicy' Text [ApplicationPolicyStatement]
- newPutApplicationPolicy :: Text -> PutApplicationPolicy
- data PutApplicationPolicyResponse = PutApplicationPolicyResponse' (Maybe [ApplicationPolicyStatement]) Int
- newPutApplicationPolicyResponse :: Int -> PutApplicationPolicyResponse
- data ListApplications = ListApplications' (Maybe Text) (Maybe Natural)
- newListApplications :: ListApplications
- data ListApplicationsResponse = ListApplicationsResponse' (Maybe Text) (Maybe [ApplicationSummary]) Int
- newListApplicationsResponse :: Int -> ListApplicationsResponse
- newtype Capability where
- Capability' { }
- pattern Capability_CAPABILITY_AUTO_EXPAND :: Capability
- pattern Capability_CAPABILITY_IAM :: Capability
- pattern Capability_CAPABILITY_NAMED_IAM :: Capability
- pattern Capability_CAPABILITY_RESOURCE_POLICY :: Capability
- newtype Status where
- Status' {
- fromStatus :: Text
- pattern Status_ACTIVE :: Status
- pattern Status_EXPIRED :: Status
- pattern Status_PREPARING :: Status
- Status' {
- data ApplicationDependencySummary = ApplicationDependencySummary' Text Text
- newApplicationDependencySummary :: Text -> Text -> ApplicationDependencySummary
- data ApplicationPolicyStatement = ApplicationPolicyStatement' (Maybe Text) (Maybe [Text]) [Text] [Text]
- newApplicationPolicyStatement :: ApplicationPolicyStatement
- data ApplicationSummary = ApplicationSummary' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) Text Text Text Text
- newApplicationSummary :: Text -> Text -> Text -> Text -> ApplicationSummary
- data ParameterDefinition = ParameterDefinition' (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Int) [Text] Text
- newParameterDefinition :: Text -> ParameterDefinition
- data ParameterValue = ParameterValue' Text Text
- newParameterValue :: Text -> Text -> ParameterValue
- data RollbackConfiguration = RollbackConfiguration' (Maybe [RollbackTrigger]) (Maybe Int)
- newRollbackConfiguration :: RollbackConfiguration
- data RollbackTrigger = RollbackTrigger' Text Text
- newRollbackTrigger :: Text -> Text -> RollbackTrigger
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data Version = Version' (Maybe Text) (Maybe Text) Text [ParameterDefinition] Bool Text [Capability] Text Text
- newVersion :: Text -> Bool -> Text -> Text -> Text -> Version
- data VersionSummary = VersionSummary' (Maybe Text) Text Text Text
- newVersionSummary :: Text -> Text -> Text -> VersionSummary
Service Configuration
defaultService :: Service Source #
API version 2017-09-08 of the Amazon ServerlessApplicationRepository SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ServerlessApplicationRepository.
ConflictException
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource already exists.
ForbiddenException
_ForbiddenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client is not authenticated.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource (for example, an access policy statement) specified in the request doesn't exist.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client is sending more than the allowed number of requests per unit of time.
InternalServerErrorException
_InternalServerErrorException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The AWS Serverless Application Repository service encountered an internal error.
BadRequestException
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One of the parameters in the request is invalid.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetApplicationPolicy
data GetApplicationPolicy Source #
See: newGetApplicationPolicy smart constructor.
Constructors
| GetApplicationPolicy' Text |
Instances
newGetApplicationPolicy Source #
Create a value of GetApplicationPolicy 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:applicationId:GetApplicationPolicy', getApplicationPolicy_applicationId - The Amazon Resource Name (ARN) of the application.
data GetApplicationPolicyResponse Source #
See: newGetApplicationPolicyResponse smart constructor.
Constructors
| GetApplicationPolicyResponse' (Maybe [ApplicationPolicyStatement]) Int |
Instances
newGetApplicationPolicyResponse Source #
Create a value of GetApplicationPolicyResponse 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:statements:GetApplicationPolicyResponse', getApplicationPolicyResponse_statements - An array of policy statements applied to the application.
$sel:httpStatus:GetApplicationPolicyResponse', getApplicationPolicyResponse_httpStatus - The response's http status code.
CreateApplicationVersion
data CreateApplicationVersion Source #
See: newCreateApplicationVersion smart constructor.
Instances
newCreateApplicationVersion Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateApplicationVersion |
Create a value of CreateApplicationVersion 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:sourceCodeUrl:CreateApplicationVersion', createApplicationVersion_sourceCodeUrl - A link to a public repository for the source code of your application,
for example the URL of a specific GitHub commit.
$sel:templateBody:CreateApplicationVersion', createApplicationVersion_templateBody - The raw packaged AWS SAM template of your application.
$sel:templateUrl:CreateApplicationVersion', createApplicationVersion_templateUrl - A link to the packaged AWS SAM template of your application.
$sel:sourceCodeArchiveUrl:CreateApplicationVersion', createApplicationVersion_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:applicationId:CreateApplicationVersion', createApplicationVersion_applicationId - The Amazon Resource Name (ARN) of the application.
$sel:semanticVersion:CreateApplicationVersion', createApplicationVersion_semanticVersion - The semantic version of the new version.
data CreateApplicationVersionResponse Source #
See: newCreateApplicationVersionResponse smart constructor.
Constructors
| CreateApplicationVersionResponse' (Maybe Text) (Maybe Bool) (Maybe [Capability]) (Maybe [ParameterDefinition]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newCreateApplicationVersionResponse Source #
Create a value of CreateApplicationVersionResponse 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:CreateApplicationVersionResponse', createApplicationVersionResponse_creationTime - The date and time this resource was created.
$sel:resourcesSupported:CreateApplicationVersionResponse', createApplicationVersionResponse_resourcesSupported - Whether all of the AWS resources contained in this application are
supported in the region in which it is being retrieved.
$sel:requiredCapabilities:CreateApplicationVersionResponse', createApplicationVersionResponse_requiredCapabilities - A list of values that you must specify before you can deploy certain
applications. Some applications might include resources that can affect
permissions in your AWS account, for example, by creating new AWS
Identity and Access Management (IAM) users. For those applications, you
must explicitly acknowledge their capabilities by specifying this
parameter.
The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.
The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.
Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.
If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.
$sel:parameterDefinitions:CreateApplicationVersionResponse', createApplicationVersionResponse_parameterDefinitions - An array of parameter types supported by the application.
$sel:semanticVersion:CreateApplicationVersion', createApplicationVersionResponse_semanticVersion - The semantic version of the application:
$sel:sourceCodeUrl:CreateApplicationVersion', createApplicationVersionResponse_sourceCodeUrl - A link to a public repository for the source code of your application,
for example the URL of a specific GitHub commit.
$sel:applicationId:CreateApplicationVersion', createApplicationVersionResponse_applicationId - The application Amazon Resource Name (ARN).
$sel:templateUrl:CreateApplicationVersion', createApplicationVersionResponse_templateUrl - A link to the packaged AWS SAM template of your application.
$sel:sourceCodeArchiveUrl:CreateApplicationVersion', createApplicationVersionResponse_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:httpStatus:CreateApplicationVersionResponse', createApplicationVersionResponse_httpStatus - The response's http status code.
UnshareApplication
data UnshareApplication Source #
See: newUnshareApplication smart constructor.
Constructors
| UnshareApplication' Text Text |
Instances
newUnshareApplication Source #
Arguments
| :: Text | |
| -> Text | |
| -> UnshareApplication |
Create a value of UnshareApplication 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:applicationId:UnshareApplication', unshareApplication_applicationId - The Amazon Resource Name (ARN) of the application.
$sel:organizationId:UnshareApplication', unshareApplication_organizationId - The AWS Organization ID to unshare the application from.
data UnshareApplicationResponse Source #
See: newUnshareApplicationResponse smart constructor.
Constructors
| UnshareApplicationResponse' | |
Instances
newUnshareApplicationResponse :: UnshareApplicationResponse Source #
Create a value of UnshareApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteApplication
data DeleteApplication Source #
See: newDeleteApplication smart constructor.
Constructors
| DeleteApplication' Text |
Instances
Arguments
| :: Text | |
| -> DeleteApplication |
Create a value of DeleteApplication 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:applicationId:DeleteApplication', deleteApplication_applicationId - The Amazon Resource Name (ARN) of the application.
data DeleteApplicationResponse Source #
See: newDeleteApplicationResponse smart constructor.
Constructors
| DeleteApplicationResponse' | |
Instances
newDeleteApplicationResponse :: DeleteApplicationResponse Source #
Create a value of DeleteApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateApplication
data UpdateApplication Source #
See: newUpdateApplication smart constructor.
Constructors
| UpdateApplication' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> UpdateApplication |
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:
$sel:homePageUrl:UpdateApplication', updateApplication_homePageUrl - A URL with more information about the application, for example the
location of your GitHub repository for the application.
$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
$sel:readmeUrl: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
$sel:author: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])?$";
$sel:labels: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:description:UpdateApplication', updateApplication_description - The description of the application.
Minimum length=1. Maximum length=256
$sel:applicationId:UpdateApplication', updateApplication_applicationId - The Amazon Resource Name (ARN) of the application.
data UpdateApplicationResponse Source #
See: newUpdateApplicationResponse smart constructor.
Constructors
| UpdateApplicationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Version) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) Int |
Instances
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:
$sel:creationTime:UpdateApplicationResponse', updateApplicationResponse_creationTime - The date and time this resource was created.
$sel:homePageUrl:UpdateApplication', updateApplicationResponse_homePageUrl - A URL with more information about the application, for example the
location of your GitHub repository for the application.
$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
$sel:readmeUrl: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
$sel:applicationId:UpdateApplication', updateApplicationResponse_applicationId - The application Amazon Resource Name (ARN).
$sel:name:UpdateApplicationResponse', updateApplicationResponse_name - The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
$sel:version:UpdateApplicationResponse', updateApplicationResponse_version - Version information about the application.
$sel:author: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])?$";
$sel:labels: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:verifiedAuthorUrl:UpdateApplicationResponse', updateApplicationResponse_verifiedAuthorUrl - The URL to the public profile of a verified author. This URL is
submitted by the author.
$sel:description:UpdateApplication', updateApplicationResponse_description - The description of the application.
Minimum length=1. Maximum length=256
$sel:spdxLicenseId:UpdateApplicationResponse', updateApplicationResponse_spdxLicenseId - A valid identifier from https://spdx.org/licenses/.
$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.
$sel:httpStatus:UpdateApplicationResponse', updateApplicationResponse_httpStatus - The response's http status code.
CreateCloudFormationTemplate
data CreateCloudFormationTemplate Source #
See: newCreateCloudFormationTemplate smart constructor.
Constructors
| CreateCloudFormationTemplate' (Maybe Text) Text |
Instances
newCreateCloudFormationTemplate Source #
Create a value of CreateCloudFormationTemplate 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:semanticVersion:CreateCloudFormationTemplate', createCloudFormationTemplate_semanticVersion - The semantic version of the application:
$sel:applicationId:CreateCloudFormationTemplate', createCloudFormationTemplate_applicationId - The Amazon Resource Name (ARN) of the application.
data CreateCloudFormationTemplateResponse Source #
See: newCreateCloudFormationTemplateResponse smart constructor.
Constructors
| CreateCloudFormationTemplateResponse' (Maybe Text) (Maybe Status) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newCreateCloudFormationTemplateResponse Source #
Arguments
| :: Int | |
| -> CreateCloudFormationTemplateResponse |
Create a value of CreateCloudFormationTemplateResponse 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:CreateCloudFormationTemplateResponse', createCloudFormationTemplateResponse_creationTime - The date and time this resource was created.
$sel:status:CreateCloudFormationTemplateResponse', createCloudFormationTemplateResponse_status - Status of the template creation workflow.
Possible values: PREPARING | ACTIVE | EXPIRED
$sel:templateId:CreateCloudFormationTemplateResponse', createCloudFormationTemplateResponse_templateId - The UUID returned by CreateCloudFormationTemplate.
Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
$sel:semanticVersion:CreateCloudFormationTemplate', createCloudFormationTemplateResponse_semanticVersion - The semantic version of the application:
$sel:applicationId:CreateCloudFormationTemplate', createCloudFormationTemplateResponse_applicationId - The application Amazon Resource Name (ARN).
$sel:templateUrl:CreateCloudFormationTemplateResponse', createCloudFormationTemplateResponse_templateUrl - A link to the template that can be used to deploy the application using
AWS CloudFormation.
$sel:expirationTime:CreateCloudFormationTemplateResponse', createCloudFormationTemplateResponse_expirationTime - The date and time this template expires. Templates expire 1 hour after
creation.
$sel:httpStatus:CreateCloudFormationTemplateResponse', createCloudFormationTemplateResponse_httpStatus - The response's http status code.
CreateApplication
data CreateApplication Source #
See: newCreateApplication smart constructor.
Constructors
| CreateApplication' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text Text |
Instances
Arguments
| :: 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])?$";
data CreateApplicationResponse Source #
See: newCreateApplicationResponse smart constructor.
Constructors
| CreateApplicationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Version) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) Int |
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.
ListApplicationDependencies (Paginated)
data ListApplicationDependencies Source #
See: newListApplicationDependencies smart constructor.
Instances
newListApplicationDependencies Source #
Create a value of ListApplicationDependencies 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:semanticVersion:ListApplicationDependencies', listApplicationDependencies_semanticVersion - The semantic version of the application to get.
$sel:nextToken:ListApplicationDependencies', listApplicationDependencies_nextToken - A token to specify where to start paginating.
$sel:maxItems:ListApplicationDependencies', listApplicationDependencies_maxItems - The total number of items to return.
$sel:applicationId:ListApplicationDependencies', listApplicationDependencies_applicationId - The Amazon Resource Name (ARN) of the application.
data ListApplicationDependenciesResponse Source #
See: newListApplicationDependenciesResponse smart constructor.
Constructors
| ListApplicationDependenciesResponse' (Maybe [ApplicationDependencySummary]) (Maybe Text) Int |
Instances
newListApplicationDependenciesResponse Source #
Arguments
| :: Int | |
| -> ListApplicationDependenciesResponse |
Create a value of ListApplicationDependenciesResponse 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:dependencies:ListApplicationDependenciesResponse', listApplicationDependenciesResponse_dependencies - An array of application summaries nested in the application.
$sel:nextToken:ListApplicationDependencies', listApplicationDependenciesResponse_nextToken - The token to request the next page of results.
$sel:httpStatus:ListApplicationDependenciesResponse', listApplicationDependenciesResponse_httpStatus - The response's http status code.
ListApplicationVersions (Paginated)
data ListApplicationVersions Source #
See: newListApplicationVersions smart constructor.
Instances
newListApplicationVersions Source #
Create a value of ListApplicationVersions 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:nextToken:ListApplicationVersions', listApplicationVersions_nextToken - A token to specify where to start paginating.
$sel:maxItems:ListApplicationVersions', listApplicationVersions_maxItems - The total number of items to return.
$sel:applicationId:ListApplicationVersions', listApplicationVersions_applicationId - The Amazon Resource Name (ARN) of the application.
data ListApplicationVersionsResponse Source #
See: newListApplicationVersionsResponse smart constructor.
Constructors
| ListApplicationVersionsResponse' (Maybe [VersionSummary]) (Maybe Text) Int |
Instances
newListApplicationVersionsResponse Source #
Create a value of ListApplicationVersionsResponse 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:versions:ListApplicationVersionsResponse', listApplicationVersionsResponse_versions - An array of version summaries for the application.
$sel:nextToken:ListApplicationVersions', listApplicationVersionsResponse_nextToken - The token to request the next page of results.
$sel:httpStatus:ListApplicationVersionsResponse', listApplicationVersionsResponse_httpStatus - The response's http status code.
GetApplication
data GetApplication Source #
See: newGetApplication smart constructor.
Constructors
| GetApplication' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> GetApplication |
Create a value of GetApplication 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:semanticVersion:GetApplication', getApplication_semanticVersion - The semantic version of the application to get.
$sel:applicationId:GetApplication', getApplication_applicationId - The Amazon Resource Name (ARN) of the application.
data GetApplicationResponse Source #
See: newGetApplicationResponse smart constructor.
Constructors
| GetApplicationResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Version) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) Int |
Instances
newGetApplicationResponse Source #
Create a value of GetApplicationResponse 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:GetApplicationResponse', getApplicationResponse_creationTime - The date and time this resource was created.
$sel:homePageUrl:GetApplicationResponse', getApplicationResponse_homePageUrl - A URL with more information about the application, for example the
location of your GitHub repository for the application.
$sel:licenseUrl:GetApplicationResponse', getApplicationResponse_licenseUrl - A link to a license file of the app that matches the spdxLicenseID value
of your application.
Maximum size 5 MB
$sel:readmeUrl:GetApplicationResponse', getApplicationResponse_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:GetApplication', getApplicationResponse_applicationId - The application Amazon Resource Name (ARN).
$sel:name:GetApplicationResponse', getApplicationResponse_name - The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
$sel:version:GetApplicationResponse', getApplicationResponse_version - Version information about the application.
$sel:author:GetApplicationResponse', getApplicationResponse_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:GetApplicationResponse', getApplicationResponse_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:GetApplicationResponse', getApplicationResponse_verifiedAuthorUrl - The URL to the public profile of a verified author. This URL is
submitted by the author.
$sel:description:GetApplicationResponse', getApplicationResponse_description - The description of the application.
Minimum length=1. Maximum length=256
$sel:spdxLicenseId:GetApplicationResponse', getApplicationResponse_spdxLicenseId - A valid identifier from https://spdx.org/licenses/.
$sel:isVerifiedAuthor:GetApplicationResponse', getApplicationResponse_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:GetApplicationResponse', getApplicationResponse_httpStatus - The response's http status code.
GetCloudFormationTemplate
data GetCloudFormationTemplate Source #
See: newGetCloudFormationTemplate smart constructor.
Constructors
| GetCloudFormationTemplate' Text Text |
Instances
newGetCloudFormationTemplate Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetCloudFormationTemplate |
Create a value of GetCloudFormationTemplate 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:applicationId:GetCloudFormationTemplate', getCloudFormationTemplate_applicationId - The Amazon Resource Name (ARN) of the application.
$sel:templateId:GetCloudFormationTemplate', getCloudFormationTemplate_templateId - The UUID returned by CreateCloudFormationTemplate.
Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
data GetCloudFormationTemplateResponse Source #
See: newGetCloudFormationTemplateResponse smart constructor.
Constructors
| GetCloudFormationTemplateResponse' (Maybe Text) (Maybe Status) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newGetCloudFormationTemplateResponse Source #
Arguments
| :: Int | |
| -> GetCloudFormationTemplateResponse |
Create a value of GetCloudFormationTemplateResponse 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:GetCloudFormationTemplateResponse', getCloudFormationTemplateResponse_creationTime - The date and time this resource was created.
$sel:status:GetCloudFormationTemplateResponse', getCloudFormationTemplateResponse_status - Status of the template creation workflow.
Possible values: PREPARING | ACTIVE | EXPIRED
$sel:templateId:GetCloudFormationTemplate', getCloudFormationTemplateResponse_templateId - The UUID returned by CreateCloudFormationTemplate.
Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
$sel:semanticVersion:GetCloudFormationTemplateResponse', getCloudFormationTemplateResponse_semanticVersion - The semantic version of the application:
$sel:applicationId:GetCloudFormationTemplate', getCloudFormationTemplateResponse_applicationId - The application Amazon Resource Name (ARN).
$sel:templateUrl:GetCloudFormationTemplateResponse', getCloudFormationTemplateResponse_templateUrl - A link to the template that can be used to deploy the application using
AWS CloudFormation.
$sel:expirationTime:GetCloudFormationTemplateResponse', getCloudFormationTemplateResponse_expirationTime - The date and time this template expires. Templates expire 1 hour after
creation.
$sel:httpStatus:GetCloudFormationTemplateResponse', getCloudFormationTemplateResponse_httpStatus - The response's http status code.
CreateCloudFormationChangeSet
data CreateCloudFormationChangeSet Source #
See: newCreateCloudFormationChangeSet smart constructor.
Constructors
| CreateCloudFormationChangeSet' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [ParameterValue]) (Maybe RollbackConfiguration) (Maybe [Text]) (Maybe [Tag]) Text Text |
Instances
newCreateCloudFormationChangeSet Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateCloudFormationChangeSet |
Create a value of CreateCloudFormationChangeSet 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:clientToken:CreateCloudFormationChangeSet', createCloudFormationChangeSet_clientToken - This property corresponds to the parameter of the same name for the /AWS
CloudFormation
CreateChangeSet/
API.
$sel:templateId:CreateCloudFormationChangeSet', createCloudFormationChangeSet_templateId - The UUID returned by CreateCloudFormationTemplate.
Pattern: [0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
$sel:semanticVersion:CreateCloudFormationChangeSet', createCloudFormationChangeSet_semanticVersion - The semantic version of the application:
$sel:notificationArns:CreateCloudFormationChangeSet', createCloudFormationChangeSet_notificationArns - This property corresponds to the parameter of the same name for the /AWS
CloudFormation
CreateChangeSet/
API.
$sel:changeSetName:CreateCloudFormationChangeSet', createCloudFormationChangeSet_changeSetName - This property corresponds to the parameter of the same name for the /AWS
CloudFormation
CreateChangeSet/
API.
$sel:description:CreateCloudFormationChangeSet', createCloudFormationChangeSet_description - This property corresponds to the parameter of the same name for the /AWS
CloudFormation
CreateChangeSet/
API.
$sel:capabilities:CreateCloudFormationChangeSet', createCloudFormationChangeSet_capabilities - A list of values that you must specify before you can deploy certain
applications. Some applications might include resources that can affect
permissions in your AWS account, for example, by creating new AWS
Identity and Access Management (IAM) users. For those applications, you
must explicitly acknowledge their capabilities by specifying this
parameter.
The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.
The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS:TopicPolicy.
Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.
If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.
$sel:parameterOverrides:CreateCloudFormationChangeSet', createCloudFormationChangeSet_parameterOverrides - A list of parameter values for the parameters of the application.
$sel:rollbackConfiguration:CreateCloudFormationChangeSet', createCloudFormationChangeSet_rollbackConfiguration - This property corresponds to the parameter of the same name for the /AWS
CloudFormation
CreateChangeSet/
API.
$sel:resourceTypes:CreateCloudFormationChangeSet', createCloudFormationChangeSet_resourceTypes - This property corresponds to the parameter of the same name for the /AWS
CloudFormation
CreateChangeSet/
API.
$sel:tags:CreateCloudFormationChangeSet', createCloudFormationChangeSet_tags - This property corresponds to the parameter of the same name for the /AWS
CloudFormation
CreateChangeSet/
API.
$sel:applicationId:CreateCloudFormationChangeSet', createCloudFormationChangeSet_applicationId - The Amazon Resource Name (ARN) of the application.
$sel:stackName:CreateCloudFormationChangeSet', createCloudFormationChangeSet_stackName - This property corresponds to the parameter of the same name for the /AWS
CloudFormation
CreateChangeSet/
API.
data CreateCloudFormationChangeSetResponse Source #
See: newCreateCloudFormationChangeSetResponse smart constructor.
Constructors
| CreateCloudFormationChangeSetResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newCreateCloudFormationChangeSetResponse Source #
Arguments
| :: Int | |
| -> CreateCloudFormationChangeSetResponse |
Create a value of CreateCloudFormationChangeSetResponse 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:semanticVersion:CreateCloudFormationChangeSet', createCloudFormationChangeSetResponse_semanticVersion - The semantic version of the application:
$sel:changeSetId:CreateCloudFormationChangeSetResponse', createCloudFormationChangeSetResponse_changeSetId - The Amazon Resource Name (ARN) of the change set.
Length constraints: Minimum length of 1.
Pattern: ARN:[-a-zA-Z0-9:/]*
$sel:applicationId:CreateCloudFormationChangeSet', createCloudFormationChangeSetResponse_applicationId - The application Amazon Resource Name (ARN).
$sel:stackId:CreateCloudFormationChangeSetResponse', createCloudFormationChangeSetResponse_stackId - The unique ID of the stack.
$sel:httpStatus:CreateCloudFormationChangeSetResponse', createCloudFormationChangeSetResponse_httpStatus - The response's http status code.
PutApplicationPolicy
data PutApplicationPolicy Source #
See: newPutApplicationPolicy smart constructor.
Constructors
| PutApplicationPolicy' Text [ApplicationPolicyStatement] |
Instances
newPutApplicationPolicy Source #
Create a value of PutApplicationPolicy 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:applicationId:PutApplicationPolicy', putApplicationPolicy_applicationId - The Amazon Resource Name (ARN) of the application.
$sel:statements:PutApplicationPolicy', putApplicationPolicy_statements - An array of policy statements applied to the application.
data PutApplicationPolicyResponse Source #
See: newPutApplicationPolicyResponse smart constructor.
Constructors
| PutApplicationPolicyResponse' (Maybe [ApplicationPolicyStatement]) Int |
Instances
newPutApplicationPolicyResponse Source #
Create a value of PutApplicationPolicyResponse 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:statements:PutApplicationPolicy', putApplicationPolicyResponse_statements - An array of policy statements applied to the application.
$sel:httpStatus:PutApplicationPolicyResponse', putApplicationPolicyResponse_httpStatus - The response's http status code.
ListApplications (Paginated)
data ListApplications Source #
See: newListApplications smart constructor.
Constructors
| ListApplications' (Maybe Text) (Maybe Natural) |
Instances
newListApplications :: ListApplications Source #
Create a value of ListApplications 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:nextToken:ListApplications', listApplications_nextToken - A token to specify where to start paginating.
$sel:maxItems:ListApplications', listApplications_maxItems - The total number of items to return.
data ListApplicationsResponse Source #
See: newListApplicationsResponse smart constructor.
Constructors
| ListApplicationsResponse' (Maybe Text) (Maybe [ApplicationSummary]) Int |
Instances
newListApplicationsResponse Source #
Create a value of ListApplicationsResponse 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:nextToken:ListApplications', listApplicationsResponse_nextToken - The token to request the next page of results.
$sel:applications:ListApplicationsResponse', listApplicationsResponse_applications - An array of application summaries.
$sel:httpStatus:ListApplicationsResponse', listApplicationsResponse_httpStatus - The response's http status code.
Types
Capability
newtype Capability Source #
Values that must be specified in order to deploy some applications.
Constructors
| Capability' | |
Fields | |
Bundled Patterns
| pattern Capability_CAPABILITY_AUTO_EXPAND :: Capability | |
| pattern Capability_CAPABILITY_IAM :: Capability | |
| pattern Capability_CAPABILITY_NAMED_IAM :: Capability | |
| pattern Capability_CAPABILITY_RESOURCE_POLICY :: Capability |
Instances
Status
Constructors
| Status' | |
Fields
| |
Bundled Patterns
| pattern Status_ACTIVE :: Status | |
| pattern Status_EXPIRED :: Status | |
| pattern Status_PREPARING :: Status |
Instances
ApplicationDependencySummary
data ApplicationDependencySummary Source #
A nested application summary.
See: newApplicationDependencySummary smart constructor.
Constructors
| ApplicationDependencySummary' Text Text |
Instances
newApplicationDependencySummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> ApplicationDependencySummary |
Create a value of ApplicationDependencySummary 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:applicationId:ApplicationDependencySummary', applicationDependencySummary_applicationId - The Amazon Resource Name (ARN) of the nested application.
$sel:semanticVersion:ApplicationDependencySummary', applicationDependencySummary_semanticVersion - The semantic version of the nested application.
ApplicationPolicyStatement
data ApplicationPolicyStatement Source #
Policy statement applied to the application.
See: newApplicationPolicyStatement smart constructor.
Instances
newApplicationPolicyStatement :: ApplicationPolicyStatement Source #
Create a value of ApplicationPolicyStatement 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:statementId:ApplicationPolicyStatement', applicationPolicyStatement_statementId - A unique ID for the statement.
$sel:principalOrgIDs:ApplicationPolicyStatement', applicationPolicyStatement_principalOrgIDs - An array of PrinciplalOrgIDs, which corresponds to AWS IAM
aws:PrincipalOrgID
global condition key.
$sel:principals:ApplicationPolicyStatement', applicationPolicyStatement_principals - An array of AWS account IDs, or * to make the application public.
$sel:actions:ApplicationPolicyStatement', applicationPolicyStatement_actions - For the list of actions supported for this operation, see
Application Permissions.
ApplicationSummary
data ApplicationSummary Source #
Summary of details about the application.
See: newApplicationSummary smart constructor.
Constructors
| ApplicationSummary' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) Text Text Text Text |
Instances
newApplicationSummary Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> ApplicationSummary |
Create a value of ApplicationSummary 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:ApplicationSummary', applicationSummary_creationTime - The date and time this resource was created.
$sel:homePageUrl:ApplicationSummary', applicationSummary_homePageUrl - A URL with more information about the application, for example the
location of your GitHub repository for the application.
$sel:labels:ApplicationSummary', applicationSummary_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:spdxLicenseId:ApplicationSummary', applicationSummary_spdxLicenseId - A valid identifier from https://spdx.org/licenses/.
$sel:description:ApplicationSummary', applicationSummary_description - The description of the application.
Minimum length=1. Maximum length=256
$sel:author:ApplicationSummary', applicationSummary_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:applicationId:ApplicationSummary', applicationSummary_applicationId - The application Amazon Resource Name (ARN).
$sel:name:ApplicationSummary', applicationSummary_name - The name of the application.
Minimum length=1. Maximum length=140
Pattern: "[a-zA-Z0-9\\-]+";
ParameterDefinition
data ParameterDefinition Source #
Parameters supported by the application.
See: newParameterDefinition smart constructor.
Constructors
| ParameterDefinition' (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Int) [Text] Text |
Instances
newParameterDefinition Source #
Arguments
| :: Text | |
| -> ParameterDefinition |
Create a value of ParameterDefinition 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:maxValue:ParameterDefinition', parameterDefinition_maxValue - A numeric value that determines the largest numeric value that you want
to allow for Number types.
$sel:maxLength:ParameterDefinition', parameterDefinition_maxLength - An integer value that determines the largest number of characters that
you want to allow for String types.
$sel:constraintDescription:ParameterDefinition', parameterDefinition_constraintDescription - A string that explains a constraint when the constraint is violated. For
example, without a constraint description, a parameter that has an
allowed pattern of [A-Za-z0-9]+ displays the following error message
when the user specifies an invalid value:
Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
By adding a constraint description, such as "must contain only uppercase and lowercase letters and numbers," you can display the following customized error message:
Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.
$sel:minLength:ParameterDefinition', parameterDefinition_minLength - An integer value that determines the smallest number of characters that
you want to allow for String types.
$sel:defaultValue:ParameterDefinition', parameterDefinition_defaultValue - A value of the appropriate type for the template to use if no value is
specified when a stack is created. If you define constraints for the
parameter, you must specify a value that adheres to those constraints.
$sel:allowedPattern:ParameterDefinition', parameterDefinition_allowedPattern - A regular expression that represents the patterns to allow for String
types.
$sel:noEcho:ParameterDefinition', parameterDefinition_noEcho - Whether to mask the parameter value whenever anyone makes a call that
describes the stack. If you set the value to true, the parameter value
is masked with asterisks (*****).
$sel:type':ParameterDefinition', parameterDefinition_type - The type of the parameter.
Valid values: String | Number | List<Number> | CommaDelimitedList
String: A literal string.
For example, users can specify "MyUserName".
Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.
For example, users might specify "8888".
List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.
For example, users might specify "80,20", and then Ref results in ["80","20"].
CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas. Also, each member string is space-trimmed.
For example, users might specify "test,dev,prod", and then Ref results in ["test","dev","prod"].
$sel:allowedValues:ParameterDefinition', parameterDefinition_allowedValues - An array containing the list of values allowed for the parameter.
$sel:description:ParameterDefinition', parameterDefinition_description - A string of up to 4,000 characters that describes the parameter.
$sel:minValue:ParameterDefinition', parameterDefinition_minValue - A numeric value that determines the smallest numeric value that you want
to allow for Number types.
$sel:referencedByResources:ParameterDefinition', parameterDefinition_referencedByResources - A list of AWS SAM resources that use this parameter.
$sel:name:ParameterDefinition', parameterDefinition_name - The name of the parameter.
ParameterValue
data ParameterValue Source #
Parameter value of the application.
See: newParameterValue smart constructor.
Constructors
| ParameterValue' Text Text |
Instances
Create a value of ParameterValue 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:value:ParameterValue', parameterValue_value - The input value associated with the parameter.
$sel:name:ParameterValue', parameterValue_name - The key associated with the parameter. If you don't specify a key and
value for a particular parameter, AWS CloudFormation uses the default
value that is specified in your template.
RollbackConfiguration
data RollbackConfiguration Source #
This property corresponds to the /AWS CloudFormation RollbackConfiguration/ Data Type.
See: newRollbackConfiguration smart constructor.
Constructors
| RollbackConfiguration' (Maybe [RollbackTrigger]) (Maybe Int) |
Instances
newRollbackConfiguration :: RollbackConfiguration Source #
Create a value of RollbackConfiguration 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:rollbackTriggers:RollbackConfiguration', rollbackConfiguration_rollbackTriggers - This property corresponds to the content of the same name for the /AWS
CloudFormation
RollbackConfiguration/
Data Type.
$sel:monitoringTimeInMinutes:RollbackConfiguration', rollbackConfiguration_monitoringTimeInMinutes - This property corresponds to the content of the same name for the /AWS
CloudFormation
RollbackConfiguration/
Data Type.
RollbackTrigger
data RollbackTrigger Source #
This property corresponds to the /AWS CloudFormation RollbackTrigger/ Data Type.
See: newRollbackTrigger smart constructor.
Constructors
| RollbackTrigger' Text Text |
Instances
Create a value of RollbackTrigger 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:type':RollbackTrigger', rollbackTrigger_type - This property corresponds to the content of the same name for the /AWS
CloudFormation
RollbackTrigger/
Data Type.
$sel:arn:RollbackTrigger', rollbackTrigger_arn - This property corresponds to the content of the same name for the /AWS
CloudFormation
RollbackTrigger/
Data Type.
Tag
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
| Hashable Tag Source # | |
| ToJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.ServerlessApplicationRepository.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.ServerlessApplicationRepository.Types.Tag" "libZSservicesZSamazonka-serverlessrepoZSamazonka-serverlessrepo" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:value:Tag', tag_value - This property corresponds to the content of the same name for the /AWS
CloudFormation
Tag/
Data Type.
$sel:key:Tag', tag_key - This property corresponds to the content of the same name for the /AWS
CloudFormation
Tag/
Data Type.
Version
Application version details.
See: newVersion smart constructor.
Constructors
| Version' (Maybe Text) (Maybe Text) Text [ParameterDefinition] Bool Text [Capability] Text Text |
Instances
Create a value of Version 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:sourceCodeUrl:Version', version_sourceCodeUrl - A link to a public repository for the source code of your application,
for example the URL of a specific GitHub commit.
$sel:sourceCodeArchiveUrl:Version', version_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:templateUrl:Version', version_templateUrl - A link to the packaged AWS SAM template of your application.
$sel:parameterDefinitions:Version', version_parameterDefinitions - An array of parameter types supported by the application.
$sel:resourcesSupported:Version', version_resourcesSupported - Whether all of the AWS resources contained in this application are
supported in the region in which it is being retrieved.
$sel:creationTime:Version', version_creationTime - The date and time this resource was created.
$sel:requiredCapabilities:Version', version_requiredCapabilities - A list of values that you must specify before you can deploy certain
applications. Some applications might include resources that can affect
permissions in your AWS account, for example, by creating new AWS
Identity and Access Management (IAM) users. For those applications, you
must explicitly acknowledge their capabilities by specifying this
parameter.
The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.
The following resources require you to specify CAPABILITY_IAM or CAPABILITY_NAMED_IAM: AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, and AWS::IAM::Role. If the application contains IAM resources, you can specify either CAPABILITY_IAM or CAPABILITY_NAMED_IAM. If the application contains IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
The following resources require you to specify CAPABILITY_RESOURCE_POLICY: AWS::Lambda::Permission, AWS::IAM:Policy, AWS::ApplicationAutoScaling::ScalingPolicy, AWS::S3::BucketPolicy, AWS::SQS::QueuePolicy, and AWS::SNS::TopicPolicy.
Applications that contain one or more nested applications require you to specify CAPABILITY_AUTO_EXPAND.
If your application template contains any of the above resources, we recommend that you review all permissions associated with the application before deploying. If you don't specify this parameter for an application that requires capabilities, the call will fail.
$sel:applicationId:Version', version_applicationId - The application Amazon Resource Name (ARN).
$sel:semanticVersion:Version', version_semanticVersion - The semantic version of the application:
VersionSummary
data VersionSummary Source #
An application version summary.
See: newVersionSummary smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> VersionSummary |
Create a value of VersionSummary 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:sourceCodeUrl:VersionSummary', versionSummary_sourceCodeUrl - A link to a public repository for the source code of your application,
for example the URL of a specific GitHub commit.
$sel:creationTime:VersionSummary', versionSummary_creationTime - The date and time this resource was created.
$sel:applicationId:VersionSummary', versionSummary_applicationId - The application Amazon Resource Name (ARN).
$sel:semanticVersion:VersionSummary', versionSummary_semanticVersion - The semantic version of the application: