Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
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.
- serverlessApplicationRepository :: 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
- module Network.AWS.ServerlessApplicationRepository.GetApplicationPolicy
- module Network.AWS.ServerlessApplicationRepository.CreateApplicationVersion
- module Network.AWS.ServerlessApplicationRepository.DeleteApplication
- module Network.AWS.ServerlessApplicationRepository.UpdateApplication
- module Network.AWS.ServerlessApplicationRepository.CreateApplication
- module Network.AWS.ServerlessApplicationRepository.ListApplicationVersions
- module Network.AWS.ServerlessApplicationRepository.GetApplication
- module Network.AWS.ServerlessApplicationRepository.CreateCloudFormationChangeSet
- module Network.AWS.ServerlessApplicationRepository.PutApplicationPolicy
- module Network.AWS.ServerlessApplicationRepository.ListApplications
- data ApplicationPolicyStatement
- applicationPolicyStatement :: ApplicationPolicyStatement
- apsStatementId :: Lens' ApplicationPolicyStatement (Maybe Text)
- apsPrincipals :: Lens' ApplicationPolicyStatement [Text]
- apsActions :: Lens' ApplicationPolicyStatement [Text]
- data ApplicationSummary
- applicationSummary :: Text -> Text -> Text -> Text -> ApplicationSummary
- asCreationTime :: Lens' ApplicationSummary (Maybe Text)
- asHomePageURL :: Lens' ApplicationSummary (Maybe Text)
- asLabels :: Lens' ApplicationSummary [Text]
- asSpdxLicenseId :: Lens' ApplicationSummary (Maybe Text)
- asDescription :: Lens' ApplicationSummary Text
- asAuthor :: Lens' ApplicationSummary Text
- asApplicationId :: Lens' ApplicationSummary Text
- asName :: Lens' ApplicationSummary Text
- data ParameterDefinition
- parameterDefinition :: Text -> ParameterDefinition
- pdMaxValue :: Lens' ParameterDefinition (Maybe Int)
- pdMaxLength :: Lens' ParameterDefinition (Maybe Int)
- pdConstraintDescription :: Lens' ParameterDefinition (Maybe Text)
- pdMinLength :: Lens' ParameterDefinition (Maybe Int)
- pdDefaultValue :: Lens' ParameterDefinition (Maybe Text)
- pdAllowedPattern :: Lens' ParameterDefinition (Maybe Text)
- pdNoEcho :: Lens' ParameterDefinition (Maybe Bool)
- pdType :: Lens' ParameterDefinition (Maybe Text)
- pdAllowedValues :: Lens' ParameterDefinition [Text]
- pdDescription :: Lens' ParameterDefinition (Maybe Text)
- pdMinValue :: Lens' ParameterDefinition (Maybe Int)
- pdReferencedByResources :: Lens' ParameterDefinition [Text]
- pdName :: Lens' ParameterDefinition Text
- data ParameterValue
- parameterValue :: Text -> Text -> ParameterValue
- pvValue :: Lens' ParameterValue Text
- pvName :: Lens' ParameterValue Text
- data Version
- version :: Text -> Text -> Text -> Text -> Version
- vSourceCodeURL :: Lens' Version (Maybe Text)
- vTemplateURL :: Lens' Version Text
- vParameterDefinitions :: Lens' Version [ParameterDefinition]
- vCreationTime :: Lens' Version Text
- vApplicationId :: Lens' Version Text
- vSemanticVersion :: Lens' Version Text
- data VersionSummary
- versionSummary :: Text -> Text -> Text -> VersionSummary
- vsSourceCodeURL :: Lens' VersionSummary (Maybe Text)
- vsCreationTime :: Lens' VersionSummary Text
- vsApplicationId :: Lens' VersionSummary Text
- vsSemanticVersion :: Lens' VersionSummary Text
Service Configuration
serverlessApplicationRepository :: 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 does not exist.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The client is sending more than the allowed number of requests per unit 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
CreateApplicationVersion
DeleteApplication
UpdateApplication
CreateApplication
ListApplicationVersions
GetApplication
CreateCloudFormationChangeSet
PutApplicationPolicy
ListApplications
Types
ApplicationPolicyStatement
data ApplicationPolicyStatement Source #
Policy statement applied to the application.
See: applicationPolicyStatement
smart constructor.
applicationPolicyStatement :: ApplicationPolicyStatement Source #
Creates a value of ApplicationPolicyStatement
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
apsStatementId
- A unique ID for the statement.apsPrincipals
- An AWS account ID, or * to make the application public.apsActions
- A list of supported actions: GetApplication CreateCloudFormationChangeSet ListApplicationVersions SearchApplications Deploy (Note: This action enables all other actions above.)
apsStatementId :: Lens' ApplicationPolicyStatement (Maybe Text) Source #
A unique ID for the statement.
apsPrincipals :: Lens' ApplicationPolicyStatement [Text] Source #
An AWS account ID, or * to make the application public.
apsActions :: Lens' ApplicationPolicyStatement [Text] Source #
A list of supported actions: GetApplication CreateCloudFormationChangeSet ListApplicationVersions SearchApplications Deploy (Note: This action enables all other actions above.)
ApplicationSummary
data ApplicationSummary Source #
Summary of details about the application.
See: applicationSummary
smart constructor.
Creates a value of ApplicationSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asCreationTime
- The date/time this resource was created.asHomePageURL
- A URL with more information about the application, for example the location of your GitHub repository for the application.asLabels
- Labels to improve discovery of apps in search results. Min Length=1. Max Length=127. Maximum number of labels: 10 Pattern: "^[a-zA-Z0-9+\-_:\/@]+$";asSpdxLicenseId
- A valid identifier from https://spdx.org/licenses/ .asDescription
- The description of the application. Min Length=1. Max Length=256asAuthor
- The name of the author publishing the app. Min Length=1. Max Length=127. Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";asApplicationId
- The application ARN.asName
- The name of the application. Min Length=1. Max Length=140 Pattern: "[a-zA-Z0-9\-]+";
asCreationTime :: Lens' ApplicationSummary (Maybe Text) Source #
The date/time this resource was created.
asHomePageURL :: Lens' ApplicationSummary (Maybe Text) Source #
A URL with more information about the application, for example the location of your GitHub repository for the application.
asLabels :: Lens' ApplicationSummary [Text] Source #
Labels to improve discovery of apps in search results. Min Length=1. Max Length=127. Maximum number of labels: 10 Pattern: "^[a-zA-Z0-9+\-_:\/@]+$";
asSpdxLicenseId :: Lens' ApplicationSummary (Maybe Text) Source #
A valid identifier from https://spdx.org/licenses/ .
asDescription :: Lens' ApplicationSummary Text Source #
The description of the application. Min Length=1. Max Length=256
asAuthor :: Lens' ApplicationSummary Text Source #
The name of the author publishing the app. Min Length=1. Max Length=127. Pattern "^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$";
asApplicationId :: Lens' ApplicationSummary Text Source #
The application ARN.
asName :: Lens' ApplicationSummary Text Source #
The name of the application. Min Length=1. Max Length=140 Pattern: "[a-zA-Z0-9\-]+";
ParameterDefinition
data ParameterDefinition Source #
Parameters supported by the application.
See: parameterDefinition
smart constructor.
Creates a value of ParameterDefinition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdMaxValue
- A numeric value that determines the largest numeric value you want to allow for Number types.pdMaxLength
- An integer value that determines the largest number of characters you want to allow for String types.pdConstraintDescription
- 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.pdMinLength
- An integer value that determines the smallest number of characters you want to allow for String types.pdDefaultValue
- 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.pdAllowedPattern
- A regular expression that represents the patterns to allow for String types.pdNoEcho
- 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 (*****).pdType
- The type of the parameter. Valid values: String | Number | ListNumber | CommaDelimitedList String: A literal string. For example, users could 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 could specify "8888". ListNumber: 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 could specify "80,20", and a 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 could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].pdAllowedValues
- Array containing the list of values allowed for the parameter.pdDescription
- A string of up to 4,000 characters that describes the parameter.pdMinValue
- A numeric value that determines the smallest numeric value you want to allow for Number types.pdReferencedByResources
- A list of AWS SAM resources that use this parameter.pdName
- The name of the parameter.
pdMaxValue :: Lens' ParameterDefinition (Maybe Int) Source #
A numeric value that determines the largest numeric value you want to allow for Number types.
pdMaxLength :: Lens' ParameterDefinition (Maybe Int) Source #
An integer value that determines the largest number of characters you want to allow for String types.
pdConstraintDescription :: Lens' ParameterDefinition (Maybe Text) Source #
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.
pdMinLength :: Lens' ParameterDefinition (Maybe Int) Source #
An integer value that determines the smallest number of characters you want to allow for String types.
pdDefaultValue :: Lens' ParameterDefinition (Maybe Text) Source #
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.
pdAllowedPattern :: Lens' ParameterDefinition (Maybe Text) Source #
A regular expression that represents the patterns to allow for String types.
pdNoEcho :: Lens' ParameterDefinition (Maybe Bool) Source #
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 (*****).
pdType :: Lens' ParameterDefinition (Maybe Text) Source #
The type of the parameter. Valid values: String | Number | ListNumber | CommaDelimitedList String: A literal string. For example, users could 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 could specify "8888". ListNumber: 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 could specify "80,20", and a 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 could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].
pdAllowedValues :: Lens' ParameterDefinition [Text] Source #
Array containing the list of values allowed for the parameter.
pdDescription :: Lens' ParameterDefinition (Maybe Text) Source #
A string of up to 4,000 characters that describes the parameter.
pdMinValue :: Lens' ParameterDefinition (Maybe Int) Source #
A numeric value that determines the smallest numeric value you want to allow for Number types.
pdReferencedByResources :: Lens' ParameterDefinition [Text] Source #
A list of AWS SAM resources that use this parameter.
ParameterValue
data ParameterValue Source #
Parameter value of the application.
See: parameterValue
smart constructor.
:: Text | |
-> Text | |
-> ParameterValue |
Creates a value of ParameterValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pvName :: Lens' ParameterValue Text Source #
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.
Version
Application version details.
See: version
smart constructor.
Creates a value of Version
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vSourceCodeURL
- A link to a public repository for the source code of your application.vTemplateURL
- A link to the packaged AWS SAM template of your application.vParameterDefinitions
- Array of parameter types supported by the application.vCreationTime
- The date/time this resource was created.vApplicationId
- The application Amazon Resource Name (ARN).vSemanticVersion
- The semantic version of the application: https://semver.org/
vSourceCodeURL :: Lens' Version (Maybe Text) Source #
A link to a public repository for the source code of your application.
vTemplateURL :: Lens' Version Text Source #
A link to the packaged AWS SAM template of your application.
vParameterDefinitions :: Lens' Version [ParameterDefinition] Source #
Array of parameter types supported by the application.
vSemanticVersion :: Lens' Version Text Source #
The semantic version of the application: https://semver.org/
VersionSummary
data VersionSummary Source #
Application version summary.
See: versionSummary
smart constructor.
Creates a value of VersionSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vsSourceCodeURL
- A link to a public repository for the source code of your application.vsCreationTime
- The date/time this resource was created.vsApplicationId
- The application Amazon Resource Name (ARN).vsSemanticVersion
- The semantic version of the application: https://semver.org/
vsSourceCodeURL :: Lens' VersionSummary (Maybe Text) Source #
A link to a public repository for the source code of your application.
vsCreationTime :: Lens' VersionSummary Text Source #
The date/time this resource was created.
vsApplicationId :: Lens' VersionSummary Text Source #
The application Amazon Resource Name (ARN).
vsSemanticVersion :: Lens' VersionSummary Text Source #
The semantic version of the application: https://semver.org/