Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.
This is a public API. You do not need any credentials to call this API.
", - "authtype":"none" + "authtype":"none", + "auth":["smithy.api#noAuth"] }, "GetId":{ "name":"GetId", @@ -135,7 +138,8 @@ {"shape":"ExternalServiceException"} ], "documentation":"Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.
This is a public API. You do not need any credentials to call this API.
", - "authtype":"none" + "authtype":"none", + "auth":["smithy.api#noAuth"] }, "GetIdentityPoolRoles":{ "name":"GetIdentityPoolRoles", @@ -173,7 +177,8 @@ {"shape":"ExternalServiceException"} ], "documentation":"Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.
The OpenID token is valid for 10 minutes.
This is a public API. You do not need any credentials to call this API.
", - "authtype":"none" + "authtype":"none", + "auth":["smithy.api#noAuth"] }, "GetOpenIdTokenForDeveloperIdentity":{ "name":"GetOpenIdTokenForDeveloperIdentity", @@ -384,7 +389,8 @@ {"shape":"ExternalServiceException"} ], "documentation":"Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.
This is a public API. You do not need any credentials to call this API.
", - "authtype":"none" + "authtype":"none", + "auth":["smithy.api#noAuth"] }, "UntagResource":{ "name":"UntagResource", diff --git a/botocore/data/connect/2017-08-08/paginators-1.json b/botocore/data/connect/2017-08-08/paginators-1.json index e225ddc182..8cabe70b73 100644 --- a/botocore/data/connect/2017-08-08/paginators-1.json +++ b/botocore/data/connect/2017-08-08/paginators-1.json @@ -386,6 +386,12 @@ ], "output_token": "NextToken", "result_key": "ContactFlows" + }, + "ListAuthenticationProfiles": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AuthenticationProfileSummaryList" } } } diff --git a/botocore/data/connect/2017-08-08/service-2.json b/botocore/data/connect/2017-08-08/service-2.json index d7b330d33f..febf835fd3 100644 --- a/botocore/data/connect/2017-08-08/service-2.json +++ b/botocore/data/connect/2017-08-08/service-2.json @@ -1276,6 +1276,23 @@ ], "documentation":"This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
" }, + "DescribeAuthenticationProfile":{ + "name":"DescribeAuthenticationProfile", + "http":{ + "method":"GET", + "requestUri":"/authentication-profiles/{InstanceId}/{AuthenticationProfileId}" + }, + "input":{"shape":"DescribeAuthenticationProfileRequest"}, + "output":{"shape":"DescribeAuthenticationProfileResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Describes the target authentication profile.
" + }, "DescribeContact":{ "name":"DescribeContact", "http":{ @@ -2152,6 +2169,23 @@ ], "documentation":"This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all approved origins associated with the instance.
" }, + "ListAuthenticationProfiles":{ + "name":"ListAuthenticationProfiles", + "http":{ + "method":"GET", + "requestUri":"/authentication-profiles-summary/{InstanceId}" + }, + "input":{"shape":"ListAuthenticationProfilesRequest"}, + "output":{"shape":"ListAuthenticationProfilesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Provides summary information about the authentication profiles in a specified Amazon Connect instance.
" + }, "ListBots":{ "name":"ListBots", "http":{ @@ -3242,7 +3276,7 @@ {"shape":"ResourceConflictException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to a Connect Case.
Provides a pre-signed Amazon S3 URL in response for uploading your content.
You may only use this API to upload attachments to an Amazon Connect Case.
This API is in preview release for Amazon Connect and is subject to change.
Updates agent status.
" }, + "UpdateAuthenticationProfile":{ + "name":"UpdateAuthenticationProfile", + "http":{ + "method":"POST", + "requestUri":"/authentication-profiles/{InstanceId}/{AuthenticationProfileId}" + }, + "input":{"shape":"UpdateAuthenticationProfileRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Updates the selected authentication profile.
" + }, "UpdateContact":{ "name":"UpdateContact", "http":{ @@ -4331,6 +4381,12 @@ "error":{"httpStatusCode":403}, "exception":true }, + "AccessTokenDuration":{ + "type":"integer", + "box":true, + "max":60, + "min":10 + }, "ActionSummaries":{ "type":"list", "member":{"shape":"ActionSummary"} @@ -5470,6 +5526,109 @@ "documentation":"Contains information for score and potential quality issues for Audio
" }, "AudioQualityScore":{"type":"float"}, + "AuthenticationProfile":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"AuthenticationProfileId", + "documentation":"A unique identifier for the authentication profile.
" + }, + "Arn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) for the authentication profile.
" + }, + "Name":{ + "shape":"AuthenticationProfileName", + "documentation":"The name for the authentication profile.
" + }, + "Description":{ + "shape":"AuthenticationProfileDescription", + "documentation":"The description for the authentication profile.
" + }, + "AllowedIps":{ + "shape":"IpCidrList", + "documentation":"A list of IP address range strings that are allowed to access the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
" + }, + "BlockedIps":{ + "shape":"IpCidrList", + "documentation":"A list of IP address range strings that are blocked from accessing the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.
" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the authentication profile was created.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the authentication profile was last modified.
" + }, + "LastModifiedRegion":{ + "shape":"RegionName", + "documentation":"The Amazon Web Services Region where the authentication profile was last modified.
" + }, + "PeriodicSessionDuration":{ + "shape":"AccessTokenDuration", + "documentation":"The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
" + }, + "MaxSessionDuration":{ + "shape":"RefreshTokenDuration", + "documentation":"The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
" + } + }, + "documentation":"This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Information about an authentication profile. An authentication profile is a resource that stores the authentication settings for users in your contact center. You use authentication profiles to set up IP address range restrictions and session timeouts. For more information, see Set IP address restrictions or session timeouts.
" + }, + "AuthenticationProfileDescription":{ + "type":"string", + "max":250, + "min":1 + }, + "AuthenticationProfileId":{ + "type":"string", + "max":100, + "min":1 + }, + "AuthenticationProfileName":{ + "type":"string", + "max":128, + "min":1 + }, + "AuthenticationProfileSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"AuthenticationProfileId", + "documentation":"The unique identifier of the authentication profile.
" + }, + "Arn":{ + "shape":"ARN", + "documentation":"The Amazon Resource Name (ARN) of the authentication profile summary.
" + }, + "Name":{ + "shape":"AuthenticationProfileName", + "documentation":"The name of the authentication profile summary.
" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.
" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"The timestamp when the authentication profile summary was last modified.
" + }, + "LastModifiedRegion":{ + "shape":"RegionName", + "documentation":"The Amazon Web Services Region when the authentication profile summary was last modified.
" + } + }, + "documentation":"This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
A summary of a given authentication profile.
" + }, + "AuthenticationProfileSummaryList":{ + "type":"list", + "member":{"shape":"AuthenticationProfileSummary"} + }, "AutoAccept":{"type":"boolean"}, "AvailableNumberSummary":{ "type":"structure", @@ -5943,7 +6102,7 @@ "members":{ "InstanceId":{ "shape":"InstanceId", - "documentation":"The unique identifier of the Connect instance.
", + "documentation":"The unique identifier of the Amazon Connect instance.
", "location":"uri", "locationName":"InstanceId" }, @@ -8785,6 +8944,36 @@ } } }, + "DescribeAuthenticationProfileRequest":{ + "type":"structure", + "required":[ + "AuthenticationProfileId", + "InstanceId" + ], + "members":{ + "AuthenticationProfileId":{ + "shape":"AuthenticationProfileId", + "documentation":"A unique identifier for the authentication profile.
", + "location":"uri", + "locationName":"AuthenticationProfileId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "location":"uri", + "locationName":"InstanceId" + } + } + }, + "DescribeAuthenticationProfileResponse":{ + "type":"structure", + "members":{ + "AuthenticationProfile":{ + "shape":"AuthenticationProfile", + "documentation":"The authentication profile object being described.
" + } + } + }, "DescribeContactEvaluationRequest":{ "type":"structure", "required":[ @@ -12832,6 +13021,16 @@ "type":"list", "member":{"shape":"InvisibleFieldInfo"} }, + "IpCidr":{ + "type":"string", + "max":50, + "min":2, + "pattern":"^[A-Za-z0-9:/]*$" + }, + "IpCidrList":{ + "type":"list", + "member":{"shape":"IpCidr"} + }, "JoinToken":{ "type":"string", "sensitive":true @@ -13086,6 +13285,44 @@ } } }, + "ListAuthenticationProfilesRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "location":"uri", + "locationName":"InstanceId" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"The maximum number of results to return per page.
", + "box":true, + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListAuthenticationProfilesResponse":{ + "type":"structure", + "members":{ + "AuthenticationProfileSummaryList":{ + "shape":"AuthenticationProfileSummaryList", + "documentation":"A summary of a given authentication profile.
" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + } + } + }, "ListBotsRequest":{ "type":"structure", "required":[ @@ -17233,6 +17470,12 @@ "max":4096, "min":0 }, + "RefreshTokenDuration":{ + "type":"integer", + "box":true, + "max":720, + "min":360 + }, "RegionName":{ "type":"string", "pattern":"[a-z]{2}(-[a-z]+){1,2}(-[0-9])?" @@ -18102,7 +18345,7 @@ "members":{ "ContactFlows":{ "shape":"ContactFlowSearchSummaryList", - "documentation":"Information about the contact flows.
" + "documentation":"Information about the flows.
" }, "NextToken":{ "shape":"NextToken2500", @@ -19191,7 +19434,7 @@ }, "InstanceId":{ "shape":"InstanceId", - "documentation":"The unique identifier of the Connect instance.
", + "documentation":"The unique identifier of the Amazon Connect instance.
", "location":"uri", "locationName":"InstanceId" }, @@ -19612,7 +19855,7 @@ }, "ContactFlowId":{ "shape":"ContactFlowId", - "documentation":"The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
" + "documentation":"The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
" }, "InstanceId":{ "shape":"InstanceId", @@ -20734,6 +20977,48 @@ } } }, + "UpdateAuthenticationProfileRequest":{ + "type":"structure", + "required":[ + "AuthenticationProfileId", + "InstanceId" + ], + "members":{ + "AuthenticationProfileId":{ + "shape":"AuthenticationProfileId", + "documentation":"A unique identifier for the authentication profile.
", + "location":"uri", + "locationName":"AuthenticationProfileId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "location":"uri", + "locationName":"InstanceId" + }, + "Name":{ + "shape":"AuthenticationProfileName", + "documentation":"The name for the authentication profile.
" + }, + "Description":{ + "shape":"AuthenticationProfileDescription", + "documentation":"The description for the authentication profile.
" + }, + "AllowedIps":{ + "shape":"IpCidrList", + "documentation":"A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, seeConfigure session timeouts in the Amazon Connect Administrator Guide.
" + }, + "BlockedIps":{ + "shape":"IpCidrList", + "documentation":"A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see Configure IP-based access control in the Amazon Connect Administrator Guide.
" + }, + "PeriodicSessionDuration":{ + "shape":"AccessTokenDuration", + "documentation":"The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see Configure session timeouts in the Amazon Connect Administrator Guide.
", + "box":true + } + } + }, "UpdateCaseActionDefinition":{ "type":"structure", "required":["Fields"], @@ -23184,5 +23469,5 @@ }, "timestamp":{"type":"timestamp"} }, - "documentation":"Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
" + "documentation":"Amazon Connect is a cloud-based contact center solution that you use to set up and manage a customer contact center and provide reliable customer engagement at any scale.
Amazon Connect provides metrics and real-time reporting that enable you to optimize contact routing. You can also resolve customer issues more efficiently by getting customers in touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There are also limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
" } diff --git a/botocore/data/docdb/2014-10-31/service-2.json b/botocore/data/docdb/2014-10-31/service-2.json index 8cc37568bd..eda9de9b07 100644 --- a/botocore/data/docdb/2014-10-31/service-2.json +++ b/botocore/data/docdb/2014-10-31/service-2.json @@ -4,13 +4,15 @@ "apiVersion":"2014-10-31", "endpointPrefix":"rds", "protocol":"query", + "protocols":["query"], "serviceAbbreviation":"Amazon DocDB", "serviceFullName":"Amazon DocumentDB with MongoDB compatibility", "serviceId":"DocDB", "signatureVersion":"v4", "signingName":"rds", "uid":"docdb-2014-10-31", - "xmlNamespace":"http://rds.amazonaws.com/doc/2014-10-31/" + "xmlNamespace":"http://rds.amazonaws.com/doc/2014-10-31/", + "auth":["aws.auth#sigv4"] }, "operations":{ "AddSourceIdentifierToSubscription":{ diff --git a/botocore/data/eks/2017-11-01/service-2.json b/botocore/data/eks/2017-11-01/service-2.json index 284fb87d2a..ac6e399497 100644 --- a/botocore/data/eks/2017-11-01/service-2.json +++ b/botocore/data/eks/2017-11-01/service-2.json @@ -1501,7 +1501,8 @@ "type":"string", "enum":[ "ON_DEMAND", - "SPOT" + "SPOT", + "CAPACITY_BLOCK" ] }, "Category":{ diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index 16e3c463e3..f03ae494e2 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -21084,7 +21084,8 @@ "protocols" : [ "https" ] }, "endpoints" : { - "cn-north-1" : { } + "cn-north-1" : { }, + "cn-northwest-1" : { } } }, "airflow" : { diff --git a/botocore/data/payment-cryptography-data/2022-02-03/service-2.json b/botocore/data/payment-cryptography-data/2022-02-03/service-2.json index 01666625e5..a4f6b34c88 100644 --- a/botocore/data/payment-cryptography-data/2022-02-03/service-2.json +++ b/botocore/data/payment-cryptography-data/2022-02-03/service-2.json @@ -2,9 +2,10 @@ "version":"2.0", "metadata":{ "apiVersion":"2022-02-03", + "auth":["aws.auth#sigv4"], "endpointPrefix":"dataplane.payment-cryptography", - "jsonVersion":"1.1", "protocol":"rest-json", + "protocols":["rest-json"], "serviceFullName":"Payment Cryptography Data Plane", "serviceId":"Payment Cryptography Data", "signatureVersion":"v4", @@ -118,7 +119,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], - "documentation":"Re-encrypt ciphertext using DUKPT, Symmetric and Asymmetric Data Encryption Keys.
You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt. In asymmetric encryption, ciphertext is encrypted using public component (imported by calling ImportKey) of the asymmetric key pair created outside of Amazon Web Services Payment Cryptography.
For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA. To encrypt using DUKPT, a DUKPT key must already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be generated by calling CreateKey.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" + "documentation":"Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys.
You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt.
For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. To encrypt using DUKPT, a DUKPT key must already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be generated by calling CreateKey.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "TranslatePinData":{ "name":"TranslatePinData", @@ -275,10 +276,6 @@ "shape":"AmexCardSecurityCodeVersion2", "documentation":"Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
" }, - "CardHolderVerificationValue":{ - "shape":"CardHolderVerificationValue", - "documentation":"Card data parameters that are required to generate a cardholder verification value for the payment card.
" - }, "CardVerificationValue1":{ "shape":"CardVerificationValue1", "documentation":"Card data parameters that are required to generate Card Verification Value (CVV) for the payment card.
" @@ -287,6 +284,10 @@ "shape":"CardVerificationValue2", "documentation":"Card data parameters that are required to generate Card Verification Value (CVV2) for the payment card.
" }, + "CardHolderVerificationValue":{ + "shape":"CardHolderVerificationValue", + "documentation":"Card data parameters that are required to generate a cardholder verification value for the payment card.
" + }, "DynamicCardVerificationCode":{ "shape":"DynamicCardVerificationCode", "documentation":"Card data parameters that are required to generate CDynamic Card Verification Code (dCVC) for the payment card.
" @@ -302,22 +303,22 @@ "CardHolderVerificationValue":{ "type":"structure", "required":[ - "ApplicationTransactionCounter", + "UnpredictableNumber", "PanSequenceNumber", - "UnpredictableNumber" + "ApplicationTransactionCounter" ], "members":{ - "ApplicationTransactionCounter":{ - "shape":"HexLengthBetween2And4", - "documentation":"The transaction counter value that comes from a point of sale terminal.
" + "UnpredictableNumber":{ + "shape":"HexLengthBetween2And8", + "documentation":"A random number generated by the issuer.
" }, "PanSequenceNumber":{ - "shape":"HexLengthEquals2", + "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, - "UnpredictableNumber":{ - "shape":"HexLengthBetween2And8", - "documentation":"A random number generated by the issuer.
" + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter value that comes from a point of sale terminal.
" } }, "documentation":"Card data parameters that are required to generate a cardholder verification value for the payment card.
" @@ -330,10 +331,6 @@ "shape":"AmexCardSecurityCodeVersion2", "documentation":"Card data parameters that are required to verify a Card Security Code (CSC2) for an AMEX payment card.
" }, - "CardHolderVerificationValue":{ - "shape":"CardHolderVerificationValue", - "documentation":"Card data parameters that are required to verify a cardholder verification value for the payment card.
" - }, "CardVerificationValue1":{ "shape":"CardVerificationValue1", "documentation":"Card data parameters that are required to verify Card Verification Value (CVV) for the payment card.
" @@ -342,9 +339,9 @@ "shape":"CardVerificationValue2", "documentation":"Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.
" }, - "DiscoverDynamicCardVerificationCode":{ - "shape":"DiscoverDynamicCardVerificationCode", - "documentation":"Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.
" + "CardHolderVerificationValue":{ + "shape":"CardHolderVerificationValue", + "documentation":"Card data parameters that are required to verify a cardholder verification value for the payment card.
" }, "DynamicCardVerificationCode":{ "shape":"DynamicCardVerificationCode", @@ -353,6 +350,10 @@ "DynamicCardVerificationValue":{ "shape":"DynamicCardVerificationValue", "documentation":"Card data parameters that are required to verify CDynamic Card Verification Value (dCVV) for the payment card.
" + }, + "DiscoverDynamicCardVerificationCode":{ + "shape":"DiscoverDynamicCardVerificationCode", + "documentation":"Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.
" } }, "documentation":"Card data parameters that are requried to verify Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).
", @@ -431,11 +432,17 @@ "DecryptDataInput":{ "type":"structure", "required":[ + "KeyIdentifier", "CipherText", - "DecryptionAttributes", - "KeyIdentifier" + "DecryptionAttributes" ], "members":{ + "KeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.
When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.
", + "location":"uri", + "locationName":"KeyIdentifier" + }, "CipherText":{ "shape":"HexEvenLengthBetween16And4096", "documentation":"The ciphertext to decrypt.
" @@ -444,11 +451,9 @@ "shape":"EncryptionDecryptionAttributes", "documentation":"The encryption key type and attributes for ciphertext decryption.
" }, - "KeyIdentifier":{ - "shape":"KeyArnOrKeyAliasType", - "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.
The WrappedKeyBlock containing the encryption key for ciphertext decryption.
" } } }, @@ -477,15 +482,11 @@ "DiscoverDynamicCardVerificationCode":{ "type":"structure", "required":[ - "ApplicationTransactionCounter", "CardExpiryDate", - "UnpredictableNumber" + "UnpredictableNumber", + "ApplicationTransactionCounter" ], "members":{ - "ApplicationTransactionCounter":{ - "shape":"HexLengthBetween2And4", - "documentation":"The transaction counter value that comes from the terminal.
" - }, "CardExpiryDate":{ "shape":"NumberLengthEquals4", "documentation":"The expiry date of a payment card.
" @@ -493,6 +494,10 @@ "UnpredictableNumber":{ "shape":"HexLengthBetween2And8", "documentation":"A random number that is generated by the issuer.
" + }, + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter value that comes from the terminal.
" } }, "documentation":"Parameters that are required to generate or verify dCVC (Dynamic Card Verification Code).
" @@ -500,17 +505,17 @@ "DukptAttributes":{ "type":"structure", "required":[ - "DukptDerivationType", - "KeySerialNumber" + "KeySerialNumber", + "DukptDerivationType" ], "members":{ - "DukptDerivationType":{ - "shape":"DukptDerivationType", - "documentation":"The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.
The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
" + }, + "DukptDerivationType":{ + "shape":"DukptDerivationType", + "documentation":"The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.
Parameters that are used for Derived Unique Key Per Transaction (DUKPT) derivation algorithm.
" @@ -519,6 +524,10 @@ "type":"structure", "required":["KeySerialNumber"], "members":{ + "KeySerialNumber":{ + "shape":"HexLengthBetween10And24", + "documentation":"The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
" + }, "DukptKeyDerivationType":{ "shape":"DukptDerivationType", "documentation":"The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY
The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.
" - }, - "KeySerialNumber":{ - "shape":"HexLengthBetween10And24", - "documentation":"The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
" } }, "documentation":"Parameters required for encryption or decryption of data using DUKPT.
" @@ -548,6 +553,14 @@ "type":"structure", "required":["KeySerialNumber"], "members":{ + "KeySerialNumber":{ + "shape":"HexLengthBetween10And24", + "documentation":"The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
" + }, + "Mode":{ + "shape":"DukptEncryptionMode", + "documentation":"The block cipher method to use for encryption.
The default is CBC.
" + }, "DukptKeyDerivationType":{ "shape":"DukptDerivationType", "documentation":"The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY
An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" - }, - "KeySerialNumber":{ - "shape":"HexLengthBetween10And24", - "documentation":"The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
" - }, - "Mode":{ - "shape":"DukptEncryptionMode", - "documentation":"The block cipher method to use for encryption.
The default is CBC.
" } }, "documentation":"Parameters that are required to encrypt plaintext data using DUKPT.
" @@ -589,27 +594,27 @@ "DynamicCardVerificationCode":{ "type":"structure", "required":[ - "ApplicationTransactionCounter", + "UnpredictableNumber", "PanSequenceNumber", - "TrackData", - "UnpredictableNumber" + "ApplicationTransactionCounter", + "TrackData" ], "members":{ - "ApplicationTransactionCounter":{ - "shape":"HexLengthBetween2And4", - "documentation":"The transaction counter value that comes from the terminal.
" + "UnpredictableNumber":{ + "shape":"HexLengthBetween2And8", + "documentation":"A random number generated by the issuer.
" }, "PanSequenceNumber":{ - "shape":"HexLengthEquals2", + "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter value that comes from the terminal.
" + }, "TrackData":{ "shape":"HexLengthBetween2And160", "documentation":"The data on the two tracks of magnetic cards used for financial transactions. This includes the cardholder name, PAN, expiration date, bank ID (BIN) and several other numbers the issuing bank uses to validate the data received.
" - }, - "UnpredictableNumber":{ - "shape":"HexLengthBetween2And8", - "documentation":"A random number generated by the issuer.
" } }, "documentation":"Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).
" @@ -617,27 +622,27 @@ "DynamicCardVerificationValue":{ "type":"structure", "required":[ - "ApplicationTransactionCounter", - "CardExpiryDate", "PanSequenceNumber", - "ServiceCode" + "CardExpiryDate", + "ServiceCode", + "ApplicationTransactionCounter" ], "members":{ - "ApplicationTransactionCounter":{ - "shape":"HexLengthBetween2And4", - "documentation":"The transaction counter value that comes from the terminal.
" + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, "CardExpiryDate":{ "shape":"NumberLengthEquals4", "documentation":"The expiry date of a payment card.
" }, - "PanSequenceNumber":{ - "shape":"HexLengthEquals2", - "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" - }, "ServiceCode":{ "shape":"NumberLengthEquals3", "documentation":"The service code of the payment card. This is different from Card Security Code (CSC).
" + }, + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter value that comes from the terminal.
" } }, "documentation":"Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).
" @@ -646,34 +651,34 @@ "type":"structure", "required":[ "MajorKeyDerivationMode", - "PanSequenceNumber", "PrimaryAccountNumber", + "PanSequenceNumber", "SessionDerivationData" ], "members":{ - "InitializationVector":{ - "shape":"HexLength16Or32", - "documentation":"An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" - }, "MajorKeyDerivationMode":{ "shape":"EmvMajorKeyDerivationMode", "documentation":"The EMV derivation mode to use for ICC master key derivation as per EMV version 4.3 book 2.
" }, - "Mode":{ - "shape":"EmvEncryptionMode", - "documentation":"The block cipher method to use for encryption.
" - }, - "PanSequenceNumber":{ - "shape":"HexLengthEquals2", - "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" - }, "PrimaryAccountNumber":{ "shape":"NumberLengthBetween12And19", "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + }, "SessionDerivationData":{ "shape":"HexLengthEquals16", "documentation":"The derivation value used to derive the ICC session key. It is typically the application transaction counter value padded with zeros or previous ARQC value padded with zeros as per EMV version 4.3 book 2.
" + }, + "Mode":{ + "shape":"EmvEncryptionMode", + "documentation":"The block cipher method to use for encryption.
" + }, + "InitializationVector":{ + "shape":"HexLength16Or32", + "documentation":"An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" } }, "documentation":"Parameters for plaintext encryption using EMV keys.
" @@ -695,38 +700,38 @@ "EncryptDataInput":{ "type":"structure", "required":[ - "EncryptionAttributes", "KeyIdentifier", - "PlainText" + "PlainText", + "EncryptionAttributes" ], "members":{ - "EncryptionAttributes":{ - "shape":"EncryptionDecryptionAttributes", - "documentation":"The encryption key type and attributes for plaintext encryption.
" - }, "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", - "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.
", "location":"uri", "locationName":"KeyIdentifier" }, "PlainText":{ "shape":"HexEvenLengthBetween16And4064", "documentation":"The plaintext to be encrypted.
For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
The encryption key type and attributes for plaintext encryption.
" + }, + "WrappedKey":{ + "shape":"WrappedKey", + "documentation":"The WrappedKeyBlock containing the encryption key for plaintext encryption.
" } } }, "EncryptDataOutput":{ "type":"structure", "required":[ - "CipherText", - "KeyArn" + "KeyArn", + "CipherText" ], "members":{ - "CipherText":{ - "shape":"HexEvenLengthBetween16And4096", - "documentation":"The encrypted ciphertext.
" - }, "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "CipherText":{ + "shape":"HexEvenLengthBetween16And4096", + "documentation":"The encrypted ciphertext.
" } } }, "EncryptionDecryptionAttributes":{ "type":"structure", "members":{ + "Symmetric":{ + "shape":"SymmetricEncryptionAttributes", + "documentation":"Parameters that are required to perform encryption and decryption using symmetric keys.
" + }, "Asymmetric":{"shape":"AsymmetricEncryptionAttributes"}, "Dukpt":{"shape":"DukptEncryptionAttributes"}, "Emv":{ "shape":"EmvEncryptionAttributes", "documentation":"Parameters for plaintext encryption using EMV keys.
" - }, - "Symmetric":{ - "shape":"SymmetricEncryptionAttributes", - "documentation":"Parameters that are required to perform encryption and decryption using symmetric keys.
" } }, "documentation":"Parameters that are required to perform encryption and decryption operations.
", @@ -770,15 +779,11 @@ "GenerateCardValidationDataInput":{ "type":"structure", "required":[ - "GenerationAttributes", "KeyIdentifier", - "PrimaryAccountNumber" + "PrimaryAccountNumber", + "GenerationAttributes" ], "members":{ - "GenerationAttributes":{ - "shape":"CardGenerationAttributes", - "documentation":"The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.
" - }, "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" }, + "GenerationAttributes":{ + "shape":"CardGenerationAttributes", + "documentation":"The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.
" + }, "ValidationDataLength":{ "shape":"IntegerRangeBetween3And5Type", "documentation":"The length of the CVV or CSC to be generated. The default value is 3.
" @@ -818,26 +827,26 @@ "GenerateMacInput":{ "type":"structure", "required":[ - "GenerationAttributes", "KeyIdentifier", - "MessageData" + "MessageData", + "GenerationAttributes" ], "members":{ - "GenerationAttributes":{ - "shape":"MacAttributes", - "documentation":"The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.
" - }, "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the MAC generation encryption key.
The length of a MAC under generation.
" - }, "MessageData":{ "shape":"HexEvenLengthBetween2And4096", "documentation":"The data for which a MAC is under generation. This value must be hexBinary.
" + }, + "GenerationAttributes":{ + "shape":"MacAttributes", + "documentation":"The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.
" + }, + "MacLength":{ + "shape":"IntegerRangeBetween4And16", + "documentation":"The length of a MAC under generation.
" } } }, @@ -866,13 +875,17 @@ "GeneratePinDataInput":{ "type":"structure", "required":[ + "GenerationKeyIdentifier", "EncryptionKeyIdentifier", "GenerationAttributes", - "GenerationKeyIdentifier", - "PinBlockFormat", - "PrimaryAccountNumber" + "PrimaryAccountNumber", + "PinBlockFormat" ], "members":{ + "GenerationKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block.
The attributes and values to use for PIN, PVV, or PIN Offset generation.
" }, - "GenerationKeyIdentifier":{ - "shape":"KeyArnOrKeyAliasType", - "documentation":"The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
The length of PIN under generation.
" @@ -896,40 +901,44 @@ "PrimaryAccountNumber":{ "shape":"NumberLengthBetween12And19", "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" + }, + "PinBlockFormat":{ + "shape":"PinBlockFormatForPinData", + "documentation":"The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
The PIN block encrypted under PEK from Amazon Web Services Payment Cryptography. The encrypted PIN block is a composite of PAN (Primary Account Number) and PIN (Personal Identification Number), generated in accordance with ISO 9564 standard.
" - }, - "EncryptionKeyArn":{ + "GenerationKeyArn":{ "shape":"KeyArn", - "documentation":"The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
The keyARN of the pin data generation key that Amazon Web Services Payment Cryptography uses for PIN, PVV or PIN Offset generation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" }, - "GenerationKeyArn":{ + "EncryptionKeyArn":{ "shape":"KeyArn", - "documentation":"The keyARN of the pin data generation key that Amazon Web Services Payment Cryptography uses for PIN, PVV or PIN Offset generation.
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" }, + "EncryptedPinBlock":{ + "shape":"HexLengthBetween16And32", + "documentation":"The PIN block encrypted under PEK from Amazon Web Services Payment Cryptography. The encrypted PIN block is a composite of PAN (Primary Account Number) and PIN (Personal Identification Number), generated in accordance with ISO 9564 standard.
" + }, "PinData":{ "shape":"PinData", "documentation":"The attributes and values Amazon Web Services Payment Cryptography uses for pin data generation.
" @@ -940,142 +949,136 @@ "type":"string", "max":32, "min":16, - "pattern":"^(?:[0-9a-fA-F][0-9a-fA-F])+$", + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "HexEvenLengthBetween16And4064":{ "type":"string", "max":4064, "min":16, - "pattern":"^(?:[0-9a-fA-F][0-9a-fA-F])+$", + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "HexEvenLengthBetween16And4096":{ "type":"string", "max":4096, "min":16, - "pattern":"^(?:[0-9a-fA-F][0-9a-fA-F])+$", + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "HexEvenLengthBetween2And4096":{ "type":"string", "max":4096, "min":2, - "pattern":"^(?:[0-9a-fA-F][0-9a-fA-F])+$", + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "HexEvenLengthBetween4And128":{ "type":"string", "max":128, "min":4, - "pattern":"^(?:[0-9a-fA-F][0-9a-fA-F])+$", + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "HexLength16Or32":{ "type":"string", "max":32, "min":16, - "pattern":"^(?:[0-9a-fA-F]{16}|[0-9a-fA-F]{32})$", + "pattern":"(?:[0-9a-fA-F]{16}|[0-9a-fA-F]{32})", "sensitive":true }, "HexLengthBetween10And24":{ "type":"string", "max":24, "min":10, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" }, "HexLengthBetween16And32":{ "type":"string", "max":32, "min":16, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" }, "HexLengthBetween1And16":{ "type":"string", "max":16, "min":1, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" }, "HexLengthBetween2And1024":{ "type":"string", "max":1024, "min":2, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" }, "HexLengthBetween2And160":{ "type":"string", "max":160, "min":2, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" }, "HexLengthBetween2And4":{ "type":"string", "max":4, "min":2, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" }, "HexLengthBetween2And8":{ "type":"string", "max":8, "min":2, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" }, "HexLengthBetween4And128":{ "type":"string", "max":128, "min":4, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" }, "HexLengthEquals1":{ "type":"string", "max":1, "min":1, - "pattern":"^[0-9A-F]+$" + "pattern":"[0-9A-F]+" }, "HexLengthEquals16":{ "type":"string", "max":16, "min":16, - "pattern":"^[0-9a-fA-F]+$" - }, - "HexLengthEquals2":{ - "type":"string", - "max":2, - "min":2, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" }, "HexLengthEquals4":{ "type":"string", "max":4, "min":4, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" }, "HexLengthEquals8":{ "type":"string", "max":8, "min":8, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" }, "Ibm3624NaturalPin":{ "type":"structure", "required":[ "DecimalizationTable", - "PinValidationData", - "PinValidationDataPadCharacter" + "PinValidationDataPadCharacter", + "PinValidationData" ], "members":{ "DecimalizationTable":{ "shape":"NumberLengthEquals16", "documentation":"The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
" }, - "PinValidationData":{ - "shape":"NumberLengthBetween4And16", - "documentation":"The unique data for cardholder identification.
" - }, "PinValidationDataPadCharacter":{ "shape":"HexLengthEquals1", "documentation":"The padding character for validation data.
" - } + }, + "PinValidationData":{ + "shape":"NumberLengthBetween4And16", + "documentation":"The unique data for cardholder identification.
" + } }, "documentation":"Parameters that are required to generate or verify Ibm3624 natural PIN.
" }, @@ -1083,26 +1086,26 @@ "type":"structure", "required":[ "DecimalizationTable", - "PinOffset", + "PinValidationDataPadCharacter", "PinValidationData", - "PinValidationDataPadCharacter" + "PinOffset" ], "members":{ "DecimalizationTable":{ "shape":"NumberLengthEquals16", "documentation":"The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
" }, - "PinOffset":{ - "shape":"NumberLengthBetween4And12", - "documentation":"The PIN offset value.
" + "PinValidationDataPadCharacter":{ + "shape":"HexLengthEquals1", + "documentation":"The padding character for validation data.
" }, "PinValidationData":{ "shape":"NumberLengthBetween4And16", "documentation":"The unique data for cardholder identification.
" }, - "PinValidationDataPadCharacter":{ - "shape":"HexLengthEquals1", - "documentation":"The padding character for validation data.
" + "PinOffset":{ + "shape":"NumberLengthBetween4And12", + "documentation":"The PIN offset value.
" } }, "documentation":"Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.
" @@ -1110,27 +1113,27 @@ "Ibm3624PinOffset":{ "type":"structure", "required":[ - "DecimalizationTable", "EncryptedPinBlock", - "PinValidationData", - "PinValidationDataPadCharacter" + "DecimalizationTable", + "PinValidationDataPadCharacter", + "PinValidationData" ], "members":{ - "DecimalizationTable":{ - "shape":"NumberLengthEquals16", - "documentation":"The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
" - }, "EncryptedPinBlock":{ "shape":"HexLengthBetween16And32", "documentation":"The encrypted PIN block data. According to ISO 9564 standard, a PIN Block is an encoded representation of a payment card Personal Account Number (PAN) and the cardholder Personal Identification Number (PIN).
" }, - "PinValidationData":{ - "shape":"NumberLengthBetween4And16", - "documentation":"The unique data for cardholder identification.
" + "DecimalizationTable":{ + "shape":"NumberLengthEquals16", + "documentation":"The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
" }, "PinValidationDataPadCharacter":{ "shape":"HexLengthEquals1", "documentation":"The padding character for validation data.
" + }, + "PinValidationData":{ + "shape":"NumberLengthBetween4And16", + "documentation":"The unique data for cardholder identification.
" } }, "documentation":"Pparameters that are required to generate or verify Ibm3624 PIN offset PIN.
" @@ -1139,26 +1142,26 @@ "type":"structure", "required":[ "DecimalizationTable", - "PinOffset", + "PinValidationDataPadCharacter", "PinValidationData", - "PinValidationDataPadCharacter" + "PinOffset" ], "members":{ "DecimalizationTable":{ "shape":"NumberLengthEquals16", "documentation":"The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
" }, - "PinOffset":{ - "shape":"NumberLengthBetween4And12", - "documentation":"The PIN offset value.
" + "PinValidationDataPadCharacter":{ + "shape":"HexLengthEquals1", + "documentation":"The padding character for validation data.
" }, "PinValidationData":{ "shape":"NumberLengthBetween4And16", "documentation":"The unique data for cardholder identification.
" }, - "PinValidationDataPadCharacter":{ - "shape":"HexLengthEquals1", - "documentation":"The padding character for validation data.
" + "PinOffset":{ + "shape":"NumberLengthBetween4And12", + "documentation":"The PIN offset value.
" } }, "documentation":"Parameters that are required to generate or verify Ibm3624 PIN verification PIN.
" @@ -1167,29 +1170,29 @@ "type":"structure", "required":[ "DecimalizationTable", - "PinValidationData", - "PinValidationDataPadCharacter" + "PinValidationDataPadCharacter", + "PinValidationData" ], "members":{ "DecimalizationTable":{ "shape":"NumberLengthEquals16", "documentation":"The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
" }, - "PinValidationData":{ - "shape":"NumberLengthBetween4And16", - "documentation":"The unique data for cardholder identification.
" - }, "PinValidationDataPadCharacter":{ "shape":"HexLengthEquals1", "documentation":"The padding character for validation data.
" + }, + "PinValidationData":{ + "shape":"NumberLengthBetween4And16", + "documentation":"The unique data for cardholder identification.
" } }, "documentation":"Parameters that are required to generate or verify Ibm3624 random PIN.
" }, - "IntegerRangeBetween0And9":{ + "IntegerRangeBetween0And6":{ "type":"integer", "box":true, - "max":9, + "max":6, "min":0 }, "IntegerRangeBetween3And5Type":{ @@ -1224,19 +1227,26 @@ "type":"string", "max":150, "min":70, - "pattern":"^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$" + "pattern":"arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}" }, "KeyArnOrKeyAliasType":{ "type":"string", "max":322, "min":7, - "pattern":"^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$" + "pattern":"arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+" }, "KeyCheckValue":{ "type":"string", "max":16, "min":4, - "pattern":"^[0-9a-fA-F]+$" + "pattern":"[0-9a-fA-F]+" + }, + "KeyCheckValueAlgorithm":{ + "type":"string", + "enum":[ + "CMAC", + "ANSI_X9_24" + ] }, "MacAlgorithm":{ "type":"string", @@ -1253,21 +1263,21 @@ "MacAlgorithmDukpt":{ "type":"structure", "required":[ - "DukptKeyVariant", - "KeySerialNumber" + "KeySerialNumber", + "DukptKeyVariant" ], "members":{ - "DukptDerivationType":{ - "shape":"DukptDerivationType", - "documentation":"The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.
The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
" }, "DukptKeyVariant":{ "shape":"DukptKeyVariant", "documentation":"The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
" }, - "KeySerialNumber":{ - "shape":"HexLengthBetween10And24", - "documentation":"The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
" + "DukptDerivationType":{ + "shape":"DukptDerivationType", + "documentation":"The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.
Parameters required for DUKPT MAC generation and verification.
" @@ -1276,8 +1286,8 @@ "type":"structure", "required":[ "MajorKeyDerivationMode", - "PanSequenceNumber", "PrimaryAccountNumber", + "PanSequenceNumber", "SessionKeyDerivationMode", "SessionKeyDerivationValue" ], @@ -1286,14 +1296,14 @@ "shape":"MajorKeyDerivationMode", "documentation":"The method to use when deriving the master key for EMV MAC generation or verification.
" }, - "PanSequenceNumber":{ - "shape":"HexLengthEquals2", - "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" - }, "PrimaryAccountNumber":{ "shape":"NumberLengthBetween12And19", "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" + }, "SessionKeyDerivationMode":{ "shape":"SessionKeyDerivationMode", "documentation":"The method of deriving a session key for EMV MAC generation or verification.
" @@ -1312,9 +1322,9 @@ "shape":"MacAlgorithm", "documentation":"The encryption algorithm for MAC generation or verification.
" }, - "DukptCmac":{ - "shape":"MacAlgorithmDukpt", - "documentation":"Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
" + "EmvMac":{ + "shape":"MacAlgorithmEmv", + "documentation":"Parameters that are required for MAC generation or verification using EMV MAC algorithm.
" }, "DukptIso9797Algorithm1":{ "shape":"MacAlgorithmDukpt", @@ -1324,9 +1334,9 @@ "shape":"MacAlgorithmDukpt", "documentation":"Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
" }, - "EmvMac":{ - "shape":"MacAlgorithmEmv", - "documentation":"Parameters that are required for MAC generation or verification using EMV MAC algorithm.
" + "DukptCmac":{ + "shape":"MacAlgorithmDukpt", + "documentation":"Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
" } }, "documentation":"Parameters that are required for DUKPT, HMAC, or EMV MAC generation or verification.
", @@ -1343,44 +1353,50 @@ "type":"string", "max":19, "min":12, - "pattern":"^[0-9]+$", + "pattern":"[0-9]+", "sensitive":true }, "NumberLengthBetween3And5":{ "type":"string", "max":5, "min":3, - "pattern":"^[0-9]+$" + "pattern":"[0-9]+" }, "NumberLengthBetween4And12":{ "type":"string", "max":12, "min":4, - "pattern":"^[0-9]+$" + "pattern":"[0-9]+" }, "NumberLengthBetween4And16":{ "type":"string", "max":16, "min":4, - "pattern":"^[0-9]+$" + "pattern":"[0-9]+" }, "NumberLengthEquals16":{ "type":"string", "max":16, "min":16, - "pattern":"^[0-9]+$" + "pattern":"[0-9]+" + }, + "NumberLengthEquals2":{ + "type":"string", + "max":2, + "min":2, + "pattern":"[0-9]+" }, "NumberLengthEquals3":{ "type":"string", "max":3, "min":3, - "pattern":"^[0-9]+$" + "pattern":"[0-9]+" }, "NumberLengthEquals4":{ "type":"string", "max":4, "min":4, - "pattern":"^[0-9]+$" + "pattern":"[0-9]+" }, "PaddingType":{ "type":"string", @@ -1416,29 +1432,29 @@ "PinGenerationAttributes":{ "type":"structure", "members":{ - "Ibm3624NaturalPin":{ - "shape":"Ibm3624NaturalPin", - "documentation":"Parameters that are required to generate or verify Ibm3624 natural PIN.
" + "VisaPin":{ + "shape":"VisaPin", + "documentation":"Parameters that are required to generate or verify Visa PIN.
" }, - "Ibm3624PinFromOffset":{ - "shape":"Ibm3624PinFromOffset", - "documentation":"Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.
" + "VisaPinVerificationValue":{ + "shape":"VisaPinVerificationValue", + "documentation":"Parameters that are required to generate or verify Visa PIN Verification Value (PVV).
" }, "Ibm3624PinOffset":{ "shape":"Ibm3624PinOffset", "documentation":"Parameters that are required to generate or verify Ibm3624 PIN offset PIN.
" }, + "Ibm3624NaturalPin":{ + "shape":"Ibm3624NaturalPin", + "documentation":"Parameters that are required to generate or verify Ibm3624 natural PIN.
" + }, "Ibm3624RandomPin":{ "shape":"Ibm3624RandomPin", "documentation":"Parameters that are required to generate or verify Ibm3624 random PIN.
" }, - "VisaPin":{ - "shape":"VisaPin", - "documentation":"Parameters that are required to generate or verify Visa PIN.
" - }, - "VisaPinVerificationValue":{ - "shape":"VisaPinVerificationValue", - "documentation":"Parameters that are required to generate or verify Visa PIN Verification Value (PVV).
" + "Ibm3624PinFromOffset":{ + "shape":"Ibm3624PinFromOffset", + "documentation":"Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.
" } }, "documentation":"Parameters that are required for PIN data generation.
", @@ -1447,13 +1463,13 @@ "PinVerificationAttributes":{ "type":"structure", "members":{ - "Ibm3624Pin":{ - "shape":"Ibm3624PinVerification", - "documentation":"Parameters that are required to generate or verify Ibm3624 PIN.
" - }, "VisaPin":{ "shape":"VisaPinVerification", "documentation":"Parameters that are required to generate or verify Visa PIN.
" + }, + "Ibm3624Pin":{ + "shape":"Ibm3624PinVerification", + "documentation":"Parameters that are required to generate or verify Ibm3624 PIN.
" } }, "documentation":"Parameters that are required for PIN data verification.
", @@ -1462,13 +1478,23 @@ "ReEncryptDataInput":{ "type":"structure", "required":[ + "IncomingKeyIdentifier", + "OutgoingKeyIdentifier", "CipherText", "IncomingEncryptionAttributes", - "IncomingKeyIdentifier", - "OutgoingEncryptionAttributes", - "OutgoingKeyIdentifier" + "OutgoingEncryptionAttributes" ], "members":{ + "IncomingKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key of incoming ciphertext data.
When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.
", + "location":"uri", + "locationName":"IncomingKeyIdentifier" + }, + "OutgoingKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.
" @@ -1477,34 +1503,28 @@ "shape":"ReEncryptionAttributes", "documentation":"The attributes and values for incoming ciphertext.
" }, - "IncomingKeyIdentifier":{ - "shape":"KeyArnOrKeyAliasType", - "documentation":"The keyARN of the encryption key of incoming ciphertext data.
The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
" }, - "OutgoingKeyIdentifier":{ - "shape":"KeyArnOrKeyAliasType", - "documentation":"The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
The WrappedKeyBlock containing the encryption key of incoming ciphertext data.
" + }, + "OutgoingWrappedKey":{ + "shape":"WrappedKey", + "documentation":"The WrappedKeyBlock containing the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
" } } }, "ReEncryptDataOutput":{ "type":"structure", "required":[ - "CipherText", "KeyArn", - "KeyCheckValue" + "KeyCheckValue", + "CipherText" ], "members":{ - "CipherText":{ - "shape":"HexEvenLengthBetween16And4096", - "documentation":"The encrypted ciphertext.
" - }, "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN (Amazon Resource Name) of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
" @@ -1512,17 +1532,21 @@ "KeyCheckValue":{ "shape":"KeyCheckValue", "documentation":"The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "CipherText":{ + "shape":"HexEvenLengthBetween16And4096", + "documentation":"The encrypted ciphertext.
" } } }, "ReEncryptionAttributes":{ "type":"structure", "members":{ - "Dukpt":{"shape":"DukptEncryptionAttributes"}, "Symmetric":{ "shape":"SymmetricEncryptionAttributes", "documentation":"Parameters that are required to encrypt data using symmetric keys.
" - } + }, + "Dukpt":{"shape":"DukptEncryptionAttributes"} }, "documentation":"Parameters that are required to perform reencryption operation.
", "union":true @@ -1545,17 +1569,17 @@ "SessionKeyAmex":{ "type":"structure", "required":[ - "PanSequenceNumber", - "PrimaryAccountNumber" + "PrimaryAccountNumber", + "PanSequenceNumber" ], "members":{ - "PanSequenceNumber":{ - "shape":"HexLengthEquals2", - "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" - }, "PrimaryAccountNumber":{ "shape":"NumberLengthBetween12And19", "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" } }, "documentation":"Parameters to derive session key for an Amex payment card.
" @@ -1563,14 +1587,6 @@ "SessionKeyDerivation":{ "type":"structure", "members":{ - "Amex":{ - "shape":"SessionKeyAmex", - "documentation":"Parameters to derive session key for an Amex payment card for ARQC verification.
" - }, - "Emv2000":{ - "shape":"SessionKeyEmv2000", - "documentation":"Parameters to derive session key for an Emv2000 payment card for ARQC verification.
" - }, "EmvCommon":{ "shape":"SessionKeyEmvCommon", "documentation":"Parameters to derive session key for an Emv common payment card for ARQC verification.
" @@ -1579,6 +1595,14 @@ "shape":"SessionKeyMastercard", "documentation":"Parameters to derive session key for a Mastercard payment card for ARQC verification.
" }, + "Emv2000":{ + "shape":"SessionKeyEmv2000", + "documentation":"Parameters to derive session key for an Emv2000 payment card for ARQC verification.
" + }, + "Amex":{ + "shape":"SessionKeyAmex", + "documentation":"Parameters to derive session key for an Amex payment card for ARQC verification.
" + }, "Visa":{ "shape":"SessionKeyVisa", "documentation":"Parameters to derive session key for a Visa payment cardfor ARQC verification.
" @@ -1615,22 +1639,22 @@ "SessionKeyEmv2000":{ "type":"structure", "required":[ - "ApplicationTransactionCounter", + "PrimaryAccountNumber", "PanSequenceNumber", - "PrimaryAccountNumber" + "ApplicationTransactionCounter" ], "members":{ - "ApplicationTransactionCounter":{ - "shape":"HexLengthBetween2And4", - "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" + "PrimaryAccountNumber":{ + "shape":"NumberLengthBetween12And19", + "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" }, "PanSequenceNumber":{ - "shape":"HexLengthEquals2", + "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, - "PrimaryAccountNumber":{ - "shape":"NumberLengthBetween12And19", - "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" } }, "documentation":"Parameters to derive session key for an Emv2000 payment card for ARQC verification.
" @@ -1638,22 +1662,22 @@ "SessionKeyEmvCommon":{ "type":"structure", "required":[ - "ApplicationTransactionCounter", + "PrimaryAccountNumber", "PanSequenceNumber", - "PrimaryAccountNumber" + "ApplicationTransactionCounter" ], "members":{ - "ApplicationTransactionCounter":{ - "shape":"HexLengthBetween2And4", - "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" + "PrimaryAccountNumber":{ + "shape":"NumberLengthBetween12And19", + "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" }, "PanSequenceNumber":{ - "shape":"HexLengthEquals2", + "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, - "PrimaryAccountNumber":{ - "shape":"NumberLengthBetween12And19", - "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" } }, "documentation":"Parameters to derive session key for an Emv common payment card for ARQC verification.
" @@ -1661,23 +1685,23 @@ "SessionKeyMastercard":{ "type":"structure", "required":[ - "ApplicationTransactionCounter", - "PanSequenceNumber", "PrimaryAccountNumber", + "PanSequenceNumber", + "ApplicationTransactionCounter", "UnpredictableNumber" ], "members":{ - "ApplicationTransactionCounter":{ - "shape":"HexLengthBetween2And4", - "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" + "PrimaryAccountNumber":{ + "shape":"NumberLengthBetween12And19", + "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" }, "PanSequenceNumber":{ - "shape":"HexLengthEquals2", + "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, - "PrimaryAccountNumber":{ - "shape":"NumberLengthBetween12And19", - "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + "ApplicationTransactionCounter":{ + "shape":"HexLengthBetween2And4", + "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" }, "UnpredictableNumber":{ "shape":"HexLengthBetween2And8", @@ -1689,17 +1713,17 @@ "SessionKeyVisa":{ "type":"structure", "required":[ - "PanSequenceNumber", - "PrimaryAccountNumber" + "PrimaryAccountNumber", + "PanSequenceNumber" ], "members":{ - "PanSequenceNumber":{ - "shape":"HexLengthEquals2", - "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" - }, "PrimaryAccountNumber":{ "shape":"NumberLengthBetween12And19", "documentation":"The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" + }, + "PanSequenceNumber":{ + "shape":"NumberLengthEquals2", + "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" } }, "documentation":"Parameters to derive session key for Visa payment card for ARQC verification.
" @@ -1709,14 +1733,14 @@ "type":"structure", "required":["Mode"], "members":{ - "InitializationVector":{ - "shape":"HexLength16Or32", - "documentation":"An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" - }, "Mode":{ "shape":"EncryptionMode", "documentation":"The block cipher method to use for encryption.
" }, + "InitializationVector":{ + "shape":"HexLength16Or32", + "documentation":"An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" + }, "PaddingType":{ "shape":"PaddingType", "documentation":"The padding to be included with the data.
" @@ -1736,16 +1760,39 @@ }, "exception":true }, + "Tr31WrappedKeyBlock":{ + "type":"string", + "max":9984, + "min":56, + "pattern":"[0-9A-Z]+", + "sensitive":true + }, "TranslatePinDataInput":{ "type":"structure", "required":[ - "EncryptedPinBlock", "IncomingKeyIdentifier", - "IncomingTranslationAttributes", "OutgoingKeyIdentifier", - "OutgoingTranslationAttributes" + "IncomingTranslationAttributes", + "OutgoingTranslationAttributes", + "EncryptedPinBlock" ], "members":{ + "IncomingKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key under which incoming PIN block data is encrypted. This key type can be PEK or BDK.
When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key for PIN block. Otherwise, it is the key identifier used to perform the operation.
" + }, + "OutgoingKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.
The format of the incoming PIN block data for translation within Amazon Web Services Payment Cryptography.
" + }, + "OutgoingTranslationAttributes":{ + "shape":"TranslationIsoFormats", + "documentation":"The format of the outgoing PIN block data after translation by Amazon Web Services Payment Cryptography.
" + }, "EncryptedPinBlock":{ "shape":"HexEvenLengthBetween16And32", "documentation":"The encrypted PIN block data that Amazon Web Services Payment Cryptography translates.
" @@ -1754,36 +1801,32 @@ "shape":"DukptDerivationAttributes", "documentation":"The attributes and values to use for incoming DUKPT encryption key for PIN block translation.
" }, - "IncomingKeyIdentifier":{ - "shape":"KeyArnOrKeyAliasType", - "documentation":"The keyARN of the encryption key under which incoming PIN block data is encrypted. This key type can be PEK or BDK.
The format of the incoming PIN block data for translation within Amazon Web Services Payment Cryptography.
" - }, "OutgoingDukptAttributes":{ "shape":"DukptDerivationAttributes", "documentation":"The attributes and values to use for outgoing DUKPT encryption key after PIN block translation.
" }, - "OutgoingKeyIdentifier":{ - "shape":"KeyArnOrKeyAliasType", - "documentation":"The keyARN of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.
The WrappedKeyBlock containing the encryption key under which incoming PIN block data is encrypted.
" }, - "OutgoingTranslationAttributes":{ - "shape":"TranslationIsoFormats", - "documentation":"The format of the outgoing PIN block data after translation by Amazon Web Services Payment Cryptography.
" + "OutgoingWrappedKey":{ + "shape":"WrappedKey", + "documentation":"The WrappedKeyBlock containing the encryption key for encrypting outgoing PIN block data.
" } } }, "TranslatePinDataOutput":{ "type":"structure", "required":[ + "PinBlock", "KeyArn", - "KeyCheckValue", - "PinBlock" + "KeyCheckValue" ], "members":{ + "PinBlock":{ + "shape":"HexLengthBetween16And32", + "documentation":"The outgoing encrypted PIN block data after translation.
" + }, "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to encrypt outgoing PIN block data after translation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" - }, - "PinBlock":{ - "shape":"HexLengthBetween16And32", - "documentation":"The outgoing encrypted PIN block data after translation.
" } } }, @@ -1842,11 +1881,11 @@ "type":"structure", "required":["message"], "members":{ + "message":{"shape":"String"}, "fieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"The request was denied due to an invalid request error.
" - }, - "message":{"shape":"String"} + } }, "documentation":"The request was denied due to an invalid request error.
", "exception":true @@ -1854,15 +1893,15 @@ "ValidationExceptionField":{ "type":"structure", "required":[ - "message", - "path" + "path", + "message" ], "members":{ - "message":{ + "path":{ "shape":"String", "documentation":"The request was denied due to an invalid request error.
" }, - "path":{ + "message":{ "shape":"String", "documentation":"The request was denied due to an invalid request error.
" } @@ -1876,15 +1915,15 @@ "VerificationFailedException":{ "type":"structure", "required":[ - "Message", - "Reason" + "Reason", + "Message" ], "members":{ - "Message":{"shape":"String"}, "Reason":{ "shape":"VerificationFailedReason", "documentation":"The reason for the exception.
" - } + }, + "Message":{"shape":"String"} }, "documentation":"This request failed verification.
", "error":{ @@ -1905,25 +1944,25 @@ "VerifyAuthRequestCryptogramInput":{ "type":"structure", "required":[ - "AuthRequestCryptogram", "KeyIdentifier", + "TransactionData", + "AuthRequestCryptogram", "MajorKeyDerivationMode", - "SessionKeyDerivationAttributes", - "TransactionData" + "SessionKeyDerivationAttributes" ], "members":{ - "AuthRequestCryptogram":{ - "shape":"HexLengthEquals16", - "documentation":"The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.
" - }, - "AuthResponseAttributes":{ - "shape":"CryptogramAuthResponse", - "documentation":"The attributes and values for auth request cryptogram verification. These parameters are required in case using ARPC Method 1 or Method 2 for ARQC verification.
" - }, "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.
The transaction data that Amazon Web Services Payment Cryptography uses for ARQC verification. The same transaction is used for ARQC generation outside of Amazon Web Services Payment Cryptography.
" + }, + "AuthRequestCryptogram":{ + "shape":"HexLengthEquals16", + "documentation":"The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.
" + }, "MajorKeyDerivationMode":{ "shape":"MajorKeyDerivationMode", "documentation":"The method to use when deriving the major encryption key for ARQC verification within Amazon Web Services Payment Cryptography. The same key derivation mode was used for ARQC generation outside of Amazon Web Services Payment Cryptography.
" @@ -1932,9 +1971,9 @@ "shape":"SessionKeyDerivation", "documentation":"The attributes and values to use for deriving a session key for ARQC verification within Amazon Web Services Payment Cryptography. The same attributes were used for ARQC generation outside of Amazon Web Services Payment Cryptography.
" }, - "TransactionData":{ - "shape":"HexLengthBetween2And1024", - "documentation":"The transaction data that Amazon Web Services Payment Cryptography uses for ARQC verification. The same transaction is used for ARQC generation outside of Amazon Web Services Payment Cryptography.
" + "AuthResponseAttributes":{ + "shape":"CryptogramAuthResponse", + "documentation":"The attributes and values for auth request cryptogram verification. These parameters are required in case using ARPC Method 1 or Method 2 for ARQC verification.
" } } }, @@ -1945,10 +1984,6 @@ "KeyCheckValue" ], "members":{ - "AuthResponseValue":{ - "shape":"HexLengthBetween1And16", - "documentation":"The result for ARQC verification or ARPC generation within Amazon Web Services Payment Cryptography.
" - }, "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" + }, + "AuthResponseValue":{ + "shape":"HexLengthBetween1And16", + "documentation":"The result for ARQC verification or ARPC generation within Amazon Web Services Payment Cryptography.
" } } }, @@ -1964,8 +2003,8 @@ "required":[ "KeyIdentifier", "PrimaryAccountNumber", - "ValidationData", - "VerificationAttributes" + "VerificationAttributes", + "ValidationData" ], "members":{ "KeyIdentifier":{ @@ -1976,13 +2015,13 @@ "shape":"NumberLengthBetween12And19", "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" }, - "ValidationData":{ - "shape":"NumberLengthBetween3And5", - "documentation":"The CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography.
" - }, "VerificationAttributes":{ "shape":"CardVerificationAttributes", "documentation":"The algorithm to use for verification of card data within Amazon Web Services Payment Cryptography.
" + }, + "ValidationData":{ + "shape":"NumberLengthBetween3And5", + "documentation":"The CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography.
" } } }, @@ -2007,8 +2046,8 @@ "type":"structure", "required":[ "KeyIdentifier", - "Mac", "MessageData", + "Mac", "VerificationAttributes" ], "members":{ @@ -2016,21 +2055,21 @@ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.
The MAC being verified.
" - }, - "MacLength":{ - "shape":"IntegerRangeBetween4And16", - "documentation":"The length of the MAC.
" - }, "MessageData":{ "shape":"HexEvenLengthBetween2And4096", "documentation":"The data on for which MAC is under verification. This value must be hexBinary.
" }, + "Mac":{ + "shape":"HexEvenLengthBetween4And128", + "documentation":"The MAC being verified.
" + }, "VerificationAttributes":{ "shape":"MacAttributes", "documentation":"The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.
" + }, + "MacLength":{ + "shape":"IntegerRangeBetween4And16", + "documentation":"The length of the MAC.
" } } }, @@ -2054,25 +2093,33 @@ "VerifyPinDataInput":{ "type":"structure", "required":[ - "EncryptedPinBlock", + "VerificationKeyIdentifier", "EncryptionKeyIdentifier", - "PinBlockFormat", - "PrimaryAccountNumber", "VerificationAttributes", - "VerificationKeyIdentifier" + "EncryptedPinBlock", + "PrimaryAccountNumber", + "PinBlockFormat" ], "members":{ - "DukptAttributes":{ - "shape":"DukptAttributes", - "documentation":"The attributes and values for the DUKPT encrypted PIN block data.
" + "VerificationKeyIdentifier":{ + "shape":"KeyArnOrKeyAliasType", + "documentation":"The keyARN of the PIN verification key.
The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.
The attributes and values for PIN data verification.
" }, "EncryptedPinBlock":{ "shape":"HexLengthBetween16And32", "documentation":"The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.
" }, - "EncryptionKeyIdentifier":{ - "shape":"KeyArnOrKeyAliasType", - "documentation":"The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" }, "PinBlockFormat":{ "shape":"PinBlockFormatForPinData", @@ -2082,42 +2129,34 @@ "shape":"IntegerRangeBetween4And12", "documentation":"The length of PIN being verified.
" }, - "PrimaryAccountNumber":{ - "shape":"NumberLengthBetween12And19", - "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" - }, - "VerificationAttributes":{ - "shape":"PinVerificationAttributes", - "documentation":"The attributes and values for PIN data verification.
" - }, - "VerificationKeyIdentifier":{ - "shape":"KeyArnOrKeyAliasType", - "documentation":"The keyARN of the PIN verification key.
The attributes and values for the DUKPT encrypted PIN block data.
" } } }, "VerifyPinDataOutput":{ "type":"structure", "required":[ - "EncryptionKeyArn", - "EncryptionKeyCheckValue", "VerificationKeyArn", - "VerificationKeyCheckValue" + "VerificationKeyCheckValue", + "EncryptionKeyArn", + "EncryptionKeyCheckValue" ], "members":{ - "EncryptionKeyArn":{ + "VerificationKeyArn":{ "shape":"KeyArn", - "documentation":"The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
The keyARN of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" }, - "VerificationKeyArn":{ + "EncryptionKeyArn":{ "shape":"KeyArn", - "documentation":"The keyARN of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.
Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.
" } @@ -2128,7 +2167,7 @@ "required":["PinVerificationKeyIndex"], "members":{ "PinVerificationKeyIndex":{ - "shape":"IntegerRangeBetween0And9", + "shape":"IntegerRangeBetween0And6", "documentation":"The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
" } }, @@ -2142,7 +2181,7 @@ ], "members":{ "PinVerificationKeyIndex":{ - "shape":"IntegerRangeBetween0And9", + "shape":"IntegerRangeBetween0And6", "documentation":"The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
" }, "VerificationValue":{ @@ -2164,11 +2203,37 @@ "documentation":"The encrypted PIN block data to verify.
" }, "PinVerificationKeyIndex":{ - "shape":"IntegerRangeBetween0And9", + "shape":"IntegerRangeBetween0And6", "documentation":"The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
" } }, "documentation":"Parameters that are required to generate or verify Visa PVV (PIN Verification Value).
" + }, + "WrappedKey":{ + "type":"structure", + "required":["WrappedKeyMaterial"], + "members":{ + "WrappedKeyMaterial":{ + "shape":"WrappedKeyMaterial", + "documentation":"Parameter information of a WrappedKeyBlock for encryption key exchange.
" + }, + "KeyCheckValueAlgorithm":{ + "shape":"KeyCheckValueAlgorithm", + "documentation":"The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
" + } + }, + "documentation":"Parameter information of a WrappedKeyBlock for encryption key exchange.
" + }, + "WrappedKeyMaterial":{ + "type":"structure", + "members":{ + "Tr31KeyBlock":{ + "shape":"Tr31WrappedKeyBlock", + "documentation":"The TR-31 wrapped key block.
" + } + }, + "documentation":"Parameter information of a WrappedKeyBlock for encryption key exchange.
", + "union":true } }, "documentation":"You use the Amazon Web Services Payment Cryptography Data Plane to manage how encryption keys are used for payment-related transaction processing and associated cryptographic operations. You can encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations in Amazon Web Services Payment Cryptography. For more information, see Data operations in the Amazon Web Services Payment Cryptography User Guide.
To manage your encryption keys, you use the Amazon Web Services Payment Cryptography Control Plane. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys.
" diff --git a/botocore/data/payment-cryptography-data/2022-02-03/waiters-2.json b/botocore/data/payment-cryptography-data/2022-02-03/waiters-2.json new file mode 100644 index 0000000000..13f60ee66b --- /dev/null +++ b/botocore/data/payment-cryptography-data/2022-02-03/waiters-2.json @@ -0,0 +1,5 @@ +{ + "version": 2, + "waiters": { + } +} diff --git a/botocore/data/payment-cryptography/2021-09-14/service-2.json b/botocore/data/payment-cryptography/2021-09-14/service-2.json index dd3cd6abdc..fa667a29b9 100644 --- a/botocore/data/payment-cryptography/2021-09-14/service-2.json +++ b/botocore/data/payment-cryptography/2021-09-14/service-2.json @@ -2,9 +2,11 @@ "version":"2.0", "metadata":{ "apiVersion":"2021-09-14", + "auth":["aws.auth#sigv4"], "endpointPrefix":"controlplane.payment-cryptography", "jsonVersion":"1.0", "protocol":"json", + "protocols":["json"], "serviceFullName":"Payment Cryptography Control Plane", "serviceId":"Payment Cryptography", "signatureVersion":"v4", @@ -561,6 +563,12 @@ } } }, + "EvenHexLengthBetween16And32":{ + "type":"string", + "max":32, + "min":16, + "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+" + }, "ExportAttributes":{ "type":"structure", "members":{ @@ -702,7 +710,7 @@ "documentation":"The format of key block that Amazon Web Services Payment Cryptography will use during key export.
" }, "RandomNonce":{ - "shape":"HexLength16", + "shape":"EvenHexLengthBetween16And32", "documentation":"A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
" }, "KeyBlockHeaders":{ @@ -877,12 +885,6 @@ } } }, - "HexLength16":{ - "type":"string", - "max":16, - "min":16, - "pattern":"[0-9A-F]+" - }, "HexLength20Or24":{ "type":"string", "max":24, @@ -1030,7 +1032,7 @@ "documentation":"The key block format to use during key import. The only value allowed is X9_TR34_2012.
A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
" } }, @@ -1674,7 +1676,8 @@ "type":"string", "max":9984, "min":56, - "pattern":"[0-9A-Z]+" + "pattern":"[0-9A-Z]+", + "sensitive":true }, "Tr34KeyBlockFormat":{ "type":"string", diff --git a/botocore/data/stepfunctions/2016-11-23/service-2.json b/botocore/data/stepfunctions/2016-11-23/service-2.json index cf26dad030..4d4f708c5c 100644 --- a/botocore/data/stepfunctions/2016-11-23/service-2.json +++ b/botocore/data/stepfunctions/2016-11-23/service-2.json @@ -11,7 +11,8 @@ "serviceId":"SFN", "signatureVersion":"v4", "targetPrefix":"AWSStepFunctions", - "uid":"states-2016-11-23" + "uid":"states-2016-11-23", + "auth":["aws.auth#sigv4"] }, "operations":{ "CreateActivity":{ diff --git a/botocore/data/swf/2012-01-25/service-2.json b/botocore/data/swf/2012-01-25/service-2.json index e73400a9c3..e72971db71 100644 --- a/botocore/data/swf/2012-01-25/service-2.json +++ b/botocore/data/swf/2012-01-25/service-2.json @@ -11,7 +11,8 @@ "serviceId":"SWF", "signatureVersion":"v4", "targetPrefix":"SimpleWorkflowService", - "uid":"swf-2012-01-25" + "uid":"swf-2012-01-25", + "auth":["aws.auth#sigv4"] }, "operations":{ "CountClosedWorkflowExecutions":{ diff --git a/botocore/data/wafv2/2019-07-29/service-2.json b/botocore/data/wafv2/2019-07-29/service-2.json index 933dd528df..ffe0d4ef94 100644 --- a/botocore/data/wafv2/2019-07-29/service-2.json +++ b/botocore/data/wafv2/2019-07-29/service-2.json @@ -11,7 +11,8 @@ "serviceId":"WAFV2", "signatureVersion":"v4", "targetPrefix":"AWSWAF_20190729", - "uid":"wafv2-2019-07-29" + "uid":"wafv2-2019-07-29", + "auth":["aws.auth#sigv4"] }, "operations":{ "AssociateWebACL":{ @@ -3343,14 +3344,14 @@ }, "InvalidFallbackBehavior":{ "shape":"BodyParsingFallbackBehavior", - "documentation":"What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
WAF parses the JSON in the following examples as two valid key, value pairs:
Missing comma: {\"key1\":\"value1\"\"key2\":\"value2\"}
Missing colon: {\"key1\":\"value1\",\"key2\"\"value2\"}
Extra colons: {\"key1\"::\"value1\",\"key2\"\"value2\"}
What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.
What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees.
The options for oversize handling are the following:
CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request.
NO_MATCH - Treat the web request as not matching the rule statement.
You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.
Default: CONTINUE
Inspect the body of the web request as JSON. The body immediately follows the request headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.
Example JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\" }
Inspect the body of the web request as JSON. The body immediately follows the request headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.
Example JSON: \"JsonBody\": { \"MatchPattern\": { \"All\": {} }, \"MatchScope\": \"ALL\" }
For additional information about this request component option, see JSON body in the WAF Developer Guide.
" }, "JsonMatchPattern":{ "type":"structure", diff --git a/docs/source/conf.py b/docs/source/conf.py index 0550a65a8e..521deb2b17 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.34.1' # The full version, including alpha/beta/rc tags. -release = '1.34.136' +release = '1.34.137' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.