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 |
Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases .
This requires permission for the lambda:UpdateAlias action.
- updateAlias :: Text -> Text -> UpdateAlias
- data UpdateAlias
- uaRoutingConfig :: Lens' UpdateAlias (Maybe AliasRoutingConfiguration)
- uaFunctionVersion :: Lens' UpdateAlias (Maybe Text)
- uaDescription :: Lens' UpdateAlias (Maybe Text)
- uaRevisionId :: Lens' UpdateAlias (Maybe Text)
- uaFunctionName :: Lens' UpdateAlias Text
- uaName :: Lens' UpdateAlias Text
- aliasConfiguration :: AliasConfiguration
- data AliasConfiguration
- acRoutingConfig :: Lens' AliasConfiguration (Maybe AliasRoutingConfiguration)
- acName :: Lens' AliasConfiguration (Maybe Text)
- acFunctionVersion :: Lens' AliasConfiguration (Maybe Text)
- acAliasARN :: Lens' AliasConfiguration (Maybe Text)
- acDescription :: Lens' AliasConfiguration (Maybe Text)
- acRevisionId :: Lens' AliasConfiguration (Maybe Text)
Creating a Request
Creates a value of UpdateAlias
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uaRoutingConfig
- Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see 'lambda-traffic-shifting-using-aliases' .uaFunctionVersion
- Using this parameter you can change the Lambda function version to which the alias points.uaDescription
- You can change the description of the alias using this parameter.uaRevisionId
- An optional value you can use to ensure you are updating the latest update of the function version or alias. If theRevisionID
you pass doesn't match the latestRevisionId
of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or aliasRevisionID
using either or .uaFunctionName
- The function name for which the alias is created. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.uaName
- The alias name.
data UpdateAlias Source #
See: updateAlias
smart constructor.
Request Lenses
uaRoutingConfig :: Lens' UpdateAlias (Maybe AliasRoutingConfiguration) Source #
Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see 'lambda-traffic-shifting-using-aliases' .
uaFunctionVersion :: Lens' UpdateAlias (Maybe Text) Source #
Using this parameter you can change the Lambda function version to which the alias points.
uaDescription :: Lens' UpdateAlias (Maybe Text) Source #
You can change the description of the alias using this parameter.
uaRevisionId :: Lens' UpdateAlias (Maybe Text) Source #
An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID
you pass doesn't match the latest RevisionId
of the function or alias, it will fail with an error message, advising you to retrieve the latest function version or alias RevisionID
using either or .
uaFunctionName :: Lens' UpdateAlias Text Source #
The function name for which the alias is created. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.
Destructuring the Response
aliasConfiguration :: AliasConfiguration Source #
Creates a value of AliasConfiguration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acRoutingConfig
- Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see 'lambda-traffic-shifting-using-aliases' .acName
- Alias name.acFunctionVersion
- Function version to which the alias points.acAliasARN
- Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias calledBETA
that points to a helloworld function version, the ARN isarn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA
.acDescription
- Alias description.acRevisionId
- Represents the latest updated revision of the function or alias.
data AliasConfiguration Source #
Provides configuration information about a Lambda function version alias.
See: aliasConfiguration
smart constructor.
Response Lenses
acRoutingConfig :: Lens' AliasConfiguration (Maybe AliasRoutingConfiguration) Source #
Specifies an additional function versions the alias points to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see 'lambda-traffic-shifting-using-aliases' .
acFunctionVersion :: Lens' AliasConfiguration (Maybe Text) Source #
Function version to which the alias points.
acAliasARN :: Lens' AliasConfiguration (Maybe Text) Source #
Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA
that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA
.
acDescription :: Lens' AliasConfiguration (Maybe Text) Source #
Alias description.
acRevisionId :: Lens' AliasConfiguration (Maybe Text) Source #
Represents the latest updated revision of the function or alias.