2026/05/07 - Amazon Bedrock AgentCore Control - 15 new api methods
Changes Launching AgentCore payments - a capability that provides secure, instant microtransaction payments for AI agents to access paid APIs, MCP servers, and content. It handles payment processing for x402 protocol, payment limits, and 3P wallet integrations with Coinbase CDP and Stripe (Privy).
Deletes a payment credential provider and its associated stored credentials.
See also: AWS API Documentation
Request Syntax
client.delete_payment_credential_provider(
name='string'
)
string
[REQUIRED]
The name of the payment credential provider to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new payment connector for a payment manager. A payment connector integrates with a supported payment provider to enable payment processing capabilities.
See also: AWS API Documentation
Request Syntax
client.create_payment_connector(
paymentManagerId='string',
name='string',
description='string',
type='CoinbaseCDP'|'StripePrivy',
credentialProviderConfigurations=[
{
'coinbaseCDP': {
'credentialProviderArn': 'string'
},
'stripePrivy': {
'credentialProviderArn': 'string'
}
},
],
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the payment manager to create the connector for.
string
[REQUIRED]
The name of the payment connector.
string
A description of the payment connector.
string
[REQUIRED]
The type of payment connector, which determines the payment provider integration.
list
[REQUIRED]
The credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.
(dict) --
The credential provider configuration for a payment connector. Specifies the payment provider type and its associated credential provider.
coinbaseCDP (dict) --
The credential provider configuration for a Coinbase CDP payment connector.
credentialProviderArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
stripePrivy (dict) --
The credential provider configuration for a Stripe Privy payment connector.
credentialProviderArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
string
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'paymentConnectorId': 'string',
'paymentManagerId': 'string',
'name': 'string',
'type': 'CoinbaseCDP'|'StripePrivy',
'credentialProviderConfigurations': [
{
'coinbaseCDP': {
'credentialProviderArn': 'string'
},
'stripePrivy': {
'credentialProviderArn': 'string'
}
},
],
'createdAt': datetime(2015, 1, 1),
'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
paymentConnectorId (string) --
The unique identifier of the created payment connector.
paymentManagerId (string) --
The unique identifier of the parent payment manager.
name (string) --
The name of the created payment connector.
type (string) --
The type of the created payment connector.
credentialProviderConfigurations (list) --
The credential provider configurations for the created payment connector.
(dict) --
The credential provider configuration for a payment connector. Specifies the payment provider type and its associated credential provider.
coinbaseCDP (dict) --
The credential provider configuration for a Coinbase CDP payment connector.
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
stripePrivy (dict) --
The credential provider configuration for a Stripe Privy payment connector.
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
createdAt (datetime) --
The timestamp when the payment connector was created.
status (string) --
The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
Retrieves information about a specific payment credential provider.
See also: AWS API Documentation
Request Syntax
client.get_payment_credential_provider(
name='string'
)
string
[REQUIRED]
The name of the payment credential provider to retrieve.
dict
Response Syntax
{
'name': 'string',
'credentialProviderArn': 'string',
'credentialProviderVendor': 'CoinbaseCDP'|'StripePrivy',
'providerConfigurationOutput': {
'coinbaseCdpConfiguration': {
'apiKeyId': 'string',
'apiKeySecretArn': {
'secretArn': 'string'
},
'walletSecretArn': {
'secretArn': 'string'
}
},
'stripePrivyConfiguration': {
'appId': 'string',
'appSecretArn': {
'secretArn': 'string'
},
'authorizationPrivateKeyArn': {
'secretArn': 'string'
},
'authorizationId': 'string'
}
},
'createdTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
name (string) --
The name of the payment credential provider.
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the payment credential provider.
credentialProviderVendor (string) --
Supported vendor types for payment providers using non-standard auth protocols
providerConfigurationOutput (dict) --
Output configuration (contains secret ARNs, excludes actual secret values)
coinbaseCdpConfiguration (dict) --
Coinbase CDP configuration output with secret ARNs
apiKeyId (string) --
The API key identifier provided by Coinbase Developer Platform.
apiKeySecretArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
walletSecretArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
stripePrivyConfiguration (dict) --
StripePrivy configuration output with secret ARNs
appId (string) --
The app ID provided by Privy.
appSecretArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
authorizationPrivateKeyArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
authorizationId (string) --
The authorization ID for the Stripe Privy integration.
createdTime (datetime) --
The timestamp when the payment credential provider was created.
lastUpdatedTime (datetime) --
The timestamp when the payment credential provider was last updated.
tags (dict) --
The tags associated with the payment credential provider.
(string) --
(string) --
Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.
See also: AWS API Documentation
Request Syntax
client.create_payment_credential_provider(
name='string',
credentialProviderVendor='CoinbaseCDP'|'StripePrivy',
providerConfigurationInput={
'coinbaseCdpConfiguration': {
'apiKeyId': 'string',
'apiKeySecret': 'string',
'walletSecret': 'string'
},
'stripePrivyConfiguration': {
'appId': 'string',
'appSecret': 'string',
'authorizationPrivateKey': 'string',
'authorizationId': 'string'
}
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
Unique name for the payment credential provider
string
[REQUIRED]
The vendor type (e.g., CoinbaseCDP)
dict
[REQUIRED]
Configuration specific to the vendor, including API credentials
coinbaseCdpConfiguration (dict) --
Coinbase CDP configuration - credentials provided by Coinbase Developer Platform
apiKeyId (string) -- [REQUIRED]
The API key identifier provided by Coinbase Developer Platform.
apiKeySecret (string) -- [REQUIRED]
The API key secret provided by Coinbase Developer Platform.
walletSecret (string) -- [REQUIRED]
The wallet secret provided by Coinbase Developer Platform.
stripePrivyConfiguration (dict) --
StripePrivy configuration - credentials provided by Stripe + Privy
appId (string) -- [REQUIRED]
The app ID provided by Privy.
appSecret (string) -- [REQUIRED]
The app secret provided by Privy.
authorizationPrivateKey (string) -- [REQUIRED]
The authorization private key for the Stripe Privy integration.
authorizationId (string) -- [REQUIRED]
The authorization ID for the Stripe Privy integration.
dict
Optional tags for resource organization
(string) --
(string) --
dict
Response Syntax
{
'name': 'string',
'credentialProviderVendor': 'CoinbaseCDP'|'StripePrivy',
'credentialProviderArn': 'string',
'providerConfigurationOutput': {
'coinbaseCdpConfiguration': {
'apiKeyId': 'string',
'apiKeySecretArn': {
'secretArn': 'string'
},
'walletSecretArn': {
'secretArn': 'string'
}
},
'stripePrivyConfiguration': {
'appId': 'string',
'appSecretArn': {
'secretArn': 'string'
},
'authorizationPrivateKeyArn': {
'secretArn': 'string'
},
'authorizationId': 'string'
}
}
}
Response Structure
(dict) --
name (string) --
The name of the created payment credential provider.
credentialProviderVendor (string) --
Supported vendor types for payment providers using non-standard auth protocols
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the created payment credential provider.
providerConfigurationOutput (dict) --
Output configuration (contains secret ARNs, excludes actual secret values)
coinbaseCdpConfiguration (dict) --
Coinbase CDP configuration output with secret ARNs
apiKeyId (string) --
The API key identifier provided by Coinbase Developer Platform.
apiKeySecretArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
walletSecretArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
stripePrivyConfiguration (dict) --
StripePrivy configuration output with secret ARNs
appId (string) --
The app ID provided by Privy.
appSecretArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
authorizationPrivateKeyArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
authorizationId (string) --
The authorization ID for the Stripe Privy integration.
Lists all payment connectors for a specified payment manager.
See also: AWS API Documentation
Request Syntax
client.list_payment_connectors(
paymentManagerId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the payment manager whose connectors to list.
integer
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
string
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
dict
Response Syntax
{
'paymentConnectors': [
{
'paymentConnectorId': 'string',
'name': 'string',
'type': 'CoinbaseCDP'|'StripePrivy',
'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
'lastUpdatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
paymentConnectors (list) --
The list of payment connector summaries. For details about the fields in each summary, see the PaymentConnectorSummary data type.
(dict) --
Contains summary information about a payment connector.
paymentConnectorId (string) --
The unique identifier of the payment connector.
name (string) --
The name of the payment connector.
type (string) --
The type of the payment connector, which determines the payment provider integration.
status (string) --
The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
lastUpdatedAt (datetime) --
The timestamp when the payment connector was last updated.
nextToken (string) --
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
Deletes a payment connector.
See also: AWS API Documentation
Request Syntax
client.delete_payment_connector(
paymentManagerId='string',
paymentConnectorId='string',
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the parent payment manager.
string
[REQUIRED]
The unique identifier of the payment connector to delete.
string
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
'paymentConnectorId': 'string'
}
Response Structure
(dict) --
status (string) --
The current status of the payment connector, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
paymentConnectorId (string) --
The unique identifier of the deleted payment connector.
Retrieves information about a specific payment manager.
See also: AWS API Documentation
Request Syntax
client.get_payment_manager(
paymentManagerId='string'
)
string
[REQUIRED]
The unique identifier of the payment manager to retrieve.
dict
Response Syntax
{
'paymentManagerArn': 'string',
'paymentManagerId': 'string',
'name': 'string',
'description': 'string',
'authorizerType': 'CUSTOM_JWT'|'AWS_IAM',
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'roleArn': 'string',
'workloadIdentityDetails': {
'workloadIdentityArn': 'string'
},
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
paymentManagerArn (string) --
The Amazon Resource Name (ARN) of the payment manager.
paymentManagerId (string) --
The unique identifier of the payment manager.
name (string) --
The name of the payment manager.
description (string) --
The description of the payment manager.
authorizerType (string) --
The type of authorizer used by the payment manager.
CUSTOM_JWT - Authorize with a bearer token.
AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
authorizerConfiguration (dict) --
Represents inbound authorization configuration options used to authenticate incoming requests.
customJWTAuthorizer (dict) --
The inbound JWT-based authorization, specifying how incoming requests should be authenticated.
discoveryUrl (string) --
This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.
allowedAudience (list) --
Represents individual audience values that are validated in the incoming JWT token validation process.
(string) --
allowedClients (list) --
Represents individual client IDs that are validated in the incoming JWT token validation process.
(string) --
allowedScopes (list) --
An array of scopes that are allowed to access the token.
(string) --
customClaims (list) --
An array of objects that define a custom claim validation name, value, and operation
(dict) --
Defines the name of a custom claim field and rules for finding matches to authenticate its value.
inboundTokenClaimName (string) --
The name of the custom claim field to check.
inboundTokenClaimValueType (string) --
The data type of the claim value to check for.
Use STRING if you want to find an exact match to a string you define.
Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.
authorizingClaimMatchValue (dict) --
Defines the value or values to match for and the relationship of the match.
claimMatchValue (dict) --
The value or values to match for.
matchValueString (string) --
The string value to match for.
matchValueStringList (list) --
An array of strings to check for a match.
(string) --
claimMatchOperator (string) --
Defines the relationship between the claim field value and the value or values you're matching for.
privateEndpoint (dict) --
The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.
selfManagedLatticeResource (dict) --
Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The ARN or ID of the VPC Lattice resource configuration.
managedVpcResource (dict) --
Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
vpcIdentifier (string) --
The ID of the VPC that contains your private resource.
subnetIds (list) --
The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
(string) --
endpointIpAddressType (string) --
The IP address type for the resource configuration endpoint.
securityGroupIds (list) --
The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
(string) --
tags (dict) --
Tags to apply to the managed VPC Lattice resource gateway.
(string) --
(string) --
routingDomain (string) --
An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
privateEndpointOverrides (list) --
The private endpoint overrides for the custom JWT authorizer configuration.
(dict) --
A mapping of a specific domain to a private endpoint for secure connectivity through a VPC Lattice resource configuration.
domain (string) --
The domain to override with a private endpoint.
privateEndpoint (dict) --
The private endpoint configuration for the specified domain.
selfManagedLatticeResource (dict) --
Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The ARN or ID of the VPC Lattice resource configuration.
managedVpcResource (dict) --
Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
vpcIdentifier (string) --
The ID of the VPC that contains your private resource.
subnetIds (list) --
The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
(string) --
endpointIpAddressType (string) --
The IP address type for the resource configuration endpoint.
securityGroupIds (list) --
The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
(string) --
tags (dict) --
Tags to apply to the managed VPC Lattice resource gateway.
(string) --
(string) --
routingDomain (string) --
An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.
workloadIdentityDetails (dict) --
The information about the workload identity.
workloadIdentityArn (string) --
The ARN associated with the workload identity.
createdAt (datetime) --
The timestamp when the payment manager was created.
lastUpdatedAt (datetime) --
The timestamp when the payment manager was last updated.
status (string) --
The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
tags (dict) --
The tags associated with the payment manager.
(string) --
(string) --
Updates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
See also: AWS API Documentation
Request Syntax
client.update_payment_manager(
paymentManagerId='string',
description='string',
authorizerType='CUSTOM_JWT'|'AWS_IAM',
authorizerConfiguration={
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
roleArn='string',
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the payment manager to update.
string
The updated description of the payment manager.
string
The updated authorizer type for the payment manager.
dict
The updated authorizer configuration for the payment manager.
customJWTAuthorizer (dict) --
The inbound JWT-based authorization, specifying how incoming requests should be authenticated.
discoveryUrl (string) -- [REQUIRED]
This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.
allowedAudience (list) --
Represents individual audience values that are validated in the incoming JWT token validation process.
(string) --
allowedClients (list) --
Represents individual client IDs that are validated in the incoming JWT token validation process.
(string) --
allowedScopes (list) --
An array of scopes that are allowed to access the token.
(string) --
customClaims (list) --
An array of objects that define a custom claim validation name, value, and operation
(dict) --
Defines the name of a custom claim field and rules for finding matches to authenticate its value.
inboundTokenClaimName (string) -- [REQUIRED]
The name of the custom claim field to check.
inboundTokenClaimValueType (string) -- [REQUIRED]
The data type of the claim value to check for.
Use STRING if you want to find an exact match to a string you define.
Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.
authorizingClaimMatchValue (dict) -- [REQUIRED]
Defines the value or values to match for and the relationship of the match.
claimMatchValue (dict) -- [REQUIRED]
The value or values to match for.
matchValueString (string) --
The string value to match for.
matchValueStringList (list) --
An array of strings to check for a match.
(string) --
claimMatchOperator (string) -- [REQUIRED]
Defines the relationship between the claim field value and the value or values you're matching for.
privateEndpoint (dict) --
The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.
selfManagedLatticeResource (dict) --
Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The ARN or ID of the VPC Lattice resource configuration.
managedVpcResource (dict) --
Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
vpcIdentifier (string) -- [REQUIRED]
The ID of the VPC that contains your private resource.
subnetIds (list) -- [REQUIRED]
The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
(string) --
endpointIpAddressType (string) -- [REQUIRED]
The IP address type for the resource configuration endpoint.
securityGroupIds (list) --
The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
(string) --
tags (dict) --
Tags to apply to the managed VPC Lattice resource gateway.
(string) --
(string) --
routingDomain (string) --
An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
privateEndpointOverrides (list) --
The private endpoint overrides for the custom JWT authorizer configuration.
(dict) --
A mapping of a specific domain to a private endpoint for secure connectivity through a VPC Lattice resource configuration.
domain (string) -- [REQUIRED]
The domain to override with a private endpoint.
privateEndpoint (dict) -- [REQUIRED]
The private endpoint configuration for the specified domain.
selfManagedLatticeResource (dict) --
Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The ARN or ID of the VPC Lattice resource configuration.
managedVpcResource (dict) --
Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
vpcIdentifier (string) -- [REQUIRED]
The ID of the VPC that contains your private resource.
subnetIds (list) -- [REQUIRED]
The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
(string) --
endpointIpAddressType (string) -- [REQUIRED]
The IP address type for the resource configuration endpoint.
securityGroupIds (list) --
The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
(string) --
tags (dict) --
Tags to apply to the managed VPC Lattice resource gateway.
(string) --
(string) --
routingDomain (string) --
An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
string
The updated Amazon Resource Name (ARN) of the IAM role for the payment manager.
string
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'paymentManagerArn': 'string',
'paymentManagerId': 'string',
'name': 'string',
'authorizerType': 'CUSTOM_JWT'|'AWS_IAM',
'roleArn': 'string',
'workloadIdentityDetails': {
'workloadIdentityArn': 'string'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
paymentManagerArn (string) --
The Amazon Resource Name (ARN) of the updated payment manager.
paymentManagerId (string) --
The unique identifier of the updated payment manager.
name (string) --
The name of the updated payment manager.
authorizerType (string) --
The type of authorizer for the updated payment manager.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role associated with the updated payment manager.
workloadIdentityDetails (dict) --
The information about the workload identity.
workloadIdentityArn (string) --
The ARN associated with the workload identity.
lastUpdatedAt (datetime) --
The timestamp when the payment manager was last updated.
status (string) --
The current status of the updated payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
Updates an existing payment connector. This operation uses PATCH semantics, so you only need to specify the fields you want to change.
See also: AWS API Documentation
Request Syntax
client.update_payment_connector(
paymentManagerId='string',
paymentConnectorId='string',
description='string',
type='CoinbaseCDP'|'StripePrivy',
credentialProviderConfigurations=[
{
'coinbaseCDP': {
'credentialProviderArn': 'string'
},
'stripePrivy': {
'credentialProviderArn': 'string'
}
},
],
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the parent payment manager.
string
[REQUIRED]
The unique identifier of the payment connector to update.
string
The updated description of the payment connector.
string
The updated type of the payment connector.
list
The updated credential provider configurations for the payment connector.
(dict) --
The credential provider configuration for a payment connector. Specifies the payment provider type and its associated credential provider.
coinbaseCDP (dict) --
The credential provider configuration for a Coinbase CDP payment connector.
credentialProviderArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
stripePrivy (dict) --
The credential provider configuration for a Stripe Privy payment connector.
credentialProviderArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
string
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'paymentConnectorId': 'string',
'paymentManagerId': 'string',
'name': 'string',
'type': 'CoinbaseCDP'|'StripePrivy',
'credentialProviderConfigurations': [
{
'coinbaseCDP': {
'credentialProviderArn': 'string'
},
'stripePrivy': {
'credentialProviderArn': 'string'
}
},
],
'lastUpdatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
paymentConnectorId (string) --
The unique identifier of the updated payment connector.
paymentManagerId (string) --
The unique identifier of the parent payment manager.
name (string) --
The name of the updated payment connector.
type (string) --
The type of the updated payment connector.
credentialProviderConfigurations (list) --
The credential provider configurations for the updated payment connector.
(dict) --
The credential provider configuration for a payment connector. Specifies the payment provider type and its associated credential provider.
coinbaseCDP (dict) --
The credential provider configuration for a Coinbase CDP payment connector.
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
stripePrivy (dict) --
The credential provider configuration for a Stripe Privy payment connector.
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
lastUpdatedAt (datetime) --
The timestamp when the payment connector was last updated.
status (string) --
The current status of the updated payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
Lists all payment credential providers in the account.
See also: AWS API Documentation
Request Syntax
client.list_payment_credential_providers(
nextToken='string',
maxResults=123
)
string
Pagination token.
integer
Maximum number of results to return.
dict
Response Syntax
{
'credentialProviders': [
{
'name': 'string',
'credentialProviderVendor': 'CoinbaseCDP'|'StripePrivy',
'credentialProviderArn': 'string',
'createdTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
credentialProviders (list) --
The list of payment credential providers.
(dict) --
Contains summary information about a payment credential provider.
name (string) --
The name of the payment credential provider.
credentialProviderVendor (string) --
Supported vendor types for payment providers using non-standard auth protocols
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the payment credential provider.
createdTime (datetime) --
The timestamp when the payment credential provider was created.
lastUpdatedTime (datetime) --
The timestamp when the payment credential provider was last updated.
nextToken (string) --
Pagination token for the next page of results.
Deletes a payment manager. All payment connectors associated with the payment manager must be deleted before the payment manager can be deleted. This operation initiates the deletion process asynchronously.
See also: AWS API Documentation
Request Syntax
client.delete_payment_manager(
paymentManagerId='string',
clientToken='string'
)
string
[REQUIRED]
The unique identifier of the payment manager to delete.
string
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
dict
Response Syntax
{
'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
'paymentManagerId': 'string'
}
Response Structure
(dict) --
status (string) --
The current status of the payment manager, set to DELETING when deletion is initiated. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
paymentManagerId (string) --
The unique identifier of the deleted payment manager.
Updates an existing payment credential provider with new authentication credentials.
See also: AWS API Documentation
Request Syntax
client.update_payment_credential_provider(
name='string',
credentialProviderVendor='CoinbaseCDP'|'StripePrivy',
providerConfigurationInput={
'coinbaseCdpConfiguration': {
'apiKeyId': 'string',
'apiKeySecret': 'string',
'walletSecret': 'string'
},
'stripePrivyConfiguration': {
'appId': 'string',
'appSecret': 'string',
'authorizationPrivateKey': 'string',
'authorizationId': 'string'
}
}
)
string
[REQUIRED]
The name of the payment credential provider to update.
string
[REQUIRED]
Supported vendor types for payment providers using non-standard auth protocols
dict
[REQUIRED]
Configuration specific to the vendor, including API credentials
coinbaseCdpConfiguration (dict) --
Coinbase CDP configuration - credentials provided by Coinbase Developer Platform
apiKeyId (string) -- [REQUIRED]
The API key identifier provided by Coinbase Developer Platform.
apiKeySecret (string) -- [REQUIRED]
The API key secret provided by Coinbase Developer Platform.
walletSecret (string) -- [REQUIRED]
The wallet secret provided by Coinbase Developer Platform.
stripePrivyConfiguration (dict) --
StripePrivy configuration - credentials provided by Stripe + Privy
appId (string) -- [REQUIRED]
The app ID provided by Privy.
appSecret (string) -- [REQUIRED]
The app secret provided by Privy.
authorizationPrivateKey (string) -- [REQUIRED]
The authorization private key for the Stripe Privy integration.
authorizationId (string) -- [REQUIRED]
The authorization ID for the Stripe Privy integration.
dict
Response Syntax
{
'name': 'string',
'credentialProviderVendor': 'CoinbaseCDP'|'StripePrivy',
'credentialProviderArn': 'string',
'providerConfigurationOutput': {
'coinbaseCdpConfiguration': {
'apiKeyId': 'string',
'apiKeySecretArn': {
'secretArn': 'string'
},
'walletSecretArn': {
'secretArn': 'string'
}
},
'stripePrivyConfiguration': {
'appId': 'string',
'appSecretArn': {
'secretArn': 'string'
},
'authorizationPrivateKeyArn': {
'secretArn': 'string'
},
'authorizationId': 'string'
}
},
'createdTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
name (string) --
The name of the updated payment credential provider.
credentialProviderVendor (string) --
Supported vendor types for payment providers using non-standard auth protocols
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the updated payment credential provider.
providerConfigurationOutput (dict) --
Output configuration (contains secret ARNs, excludes actual secret values)
coinbaseCdpConfiguration (dict) --
Coinbase CDP configuration output with secret ARNs
apiKeyId (string) --
The API key identifier provided by Coinbase Developer Platform.
apiKeySecretArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
walletSecretArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
stripePrivyConfiguration (dict) --
StripePrivy configuration output with secret ARNs
appId (string) --
The app ID provided by Privy.
appSecretArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
authorizationPrivateKeyArn (dict) --
Contains information about a secret in AWS Secrets Manager.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
authorizationId (string) --
The authorization ID for the Stripe Privy integration.
createdTime (datetime) --
The timestamp when the payment credential provider was created.
lastUpdatedTime (datetime) --
The timestamp when the payment credential provider was last updated.
Creates a new payment manager in your Amazon Web Services account. A payment manager serves as the top-level resource for managing payment processing capabilities, including payment connectors that integrate with supported payment providers.
If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.
See also: AWS API Documentation
Request Syntax
client.create_payment_manager(
name='string',
description='string',
authorizerType='CUSTOM_JWT'|'AWS_IAM',
authorizerConfiguration={
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
roleArn='string',
clientToken='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the payment manager.
string
A description of the payment manager.
string
[REQUIRED]
The type of authorizer to use for the payment manager.
CUSTOM_JWT - Authorize with a bearer token.
AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
dict
The authorizer configuration for the payment manager.
customJWTAuthorizer (dict) --
The inbound JWT-based authorization, specifying how incoming requests should be authenticated.
discoveryUrl (string) -- [REQUIRED]
This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.
allowedAudience (list) --
Represents individual audience values that are validated in the incoming JWT token validation process.
(string) --
allowedClients (list) --
Represents individual client IDs that are validated in the incoming JWT token validation process.
(string) --
allowedScopes (list) --
An array of scopes that are allowed to access the token.
(string) --
customClaims (list) --
An array of objects that define a custom claim validation name, value, and operation
(dict) --
Defines the name of a custom claim field and rules for finding matches to authenticate its value.
inboundTokenClaimName (string) -- [REQUIRED]
The name of the custom claim field to check.
inboundTokenClaimValueType (string) -- [REQUIRED]
The data type of the claim value to check for.
Use STRING if you want to find an exact match to a string you define.
Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.
authorizingClaimMatchValue (dict) -- [REQUIRED]
Defines the value or values to match for and the relationship of the match.
claimMatchValue (dict) -- [REQUIRED]
The value or values to match for.
matchValueString (string) --
The string value to match for.
matchValueStringList (list) --
An array of strings to check for a match.
(string) --
claimMatchOperator (string) -- [REQUIRED]
Defines the relationship between the claim field value and the value or values you're matching for.
privateEndpoint (dict) --
The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.
selfManagedLatticeResource (dict) --
Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The ARN or ID of the VPC Lattice resource configuration.
managedVpcResource (dict) --
Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
vpcIdentifier (string) -- [REQUIRED]
The ID of the VPC that contains your private resource.
subnetIds (list) -- [REQUIRED]
The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
(string) --
endpointIpAddressType (string) -- [REQUIRED]
The IP address type for the resource configuration endpoint.
securityGroupIds (list) --
The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
(string) --
tags (dict) --
Tags to apply to the managed VPC Lattice resource gateway.
(string) --
(string) --
routingDomain (string) --
An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
privateEndpointOverrides (list) --
The private endpoint overrides for the custom JWT authorizer configuration.
(dict) --
A mapping of a specific domain to a private endpoint for secure connectivity through a VPC Lattice resource configuration.
domain (string) -- [REQUIRED]
The domain to override with a private endpoint.
privateEndpoint (dict) -- [REQUIRED]
The private endpoint configuration for the specified domain.
selfManagedLatticeResource (dict) --
Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The ARN or ID of the VPC Lattice resource configuration.
managedVpcResource (dict) --
Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
vpcIdentifier (string) -- [REQUIRED]
The ID of the VPC that contains your private resource.
subnetIds (list) -- [REQUIRED]
The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
(string) --
endpointIpAddressType (string) -- [REQUIRED]
The IP address type for the resource configuration endpoint.
securityGroupIds (list) --
The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
(string) --
tags (dict) --
Tags to apply to the managed VPC Lattice resource gateway.
(string) --
(string) --
routingDomain (string) --
An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that the payment manager assumes to access resources on your behalf.
string
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
dict
A map of tag keys and values to assign to the payment manager.
(string) --
(string) --
dict
Response Syntax
{
'paymentManagerArn': 'string',
'paymentManagerId': 'string',
'name': 'string',
'authorizerType': 'CUSTOM_JWT'|'AWS_IAM',
'authorizerConfiguration': {
'customJWTAuthorizer': {
'discoveryUrl': 'string',
'allowedAudience': [
'string',
],
'allowedClients': [
'string',
],
'allowedScopes': [
'string',
],
'customClaims': [
{
'inboundTokenClaimName': 'string',
'inboundTokenClaimValueType': 'STRING'|'STRING_ARRAY',
'authorizingClaimMatchValue': {
'claimMatchValue': {
'matchValueString': 'string',
'matchValueStringList': [
'string',
]
},
'claimMatchOperator': 'EQUALS'|'CONTAINS'|'CONTAINS_ANY'
}
},
],
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
},
'privateEndpointOverrides': [
{
'domain': 'string',
'privateEndpoint': {
'selfManagedLatticeResource': {
'resourceConfigurationIdentifier': 'string'
},
'managedVpcResource': {
'vpcIdentifier': 'string',
'subnetIds': [
'string',
],
'endpointIpAddressType': 'IPV4'|'IPV6',
'securityGroupIds': [
'string',
],
'tags': {
'string': 'string'
},
'routingDomain': 'string'
}
}
},
]
}
},
'roleArn': 'string',
'workloadIdentityDetails': {
'workloadIdentityArn': 'string'
},
'createdAt': datetime(2015, 1, 1),
'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
paymentManagerArn (string) --
The Amazon Resource Name (ARN) of the created payment manager.
paymentManagerId (string) --
The unique identifier of the created payment manager.
name (string) --
The name of the created payment manager.
authorizerType (string) --
The type of authorizer for the created payment manager.
authorizerConfiguration (dict) --
Represents inbound authorization configuration options used to authenticate incoming requests.
customJWTAuthorizer (dict) --
The inbound JWT-based authorization, specifying how incoming requests should be authenticated.
discoveryUrl (string) --
This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.
allowedAudience (list) --
Represents individual audience values that are validated in the incoming JWT token validation process.
(string) --
allowedClients (list) --
Represents individual client IDs that are validated in the incoming JWT token validation process.
(string) --
allowedScopes (list) --
An array of scopes that are allowed to access the token.
(string) --
customClaims (list) --
An array of objects that define a custom claim validation name, value, and operation
(dict) --
Defines the name of a custom claim field and rules for finding matches to authenticate its value.
inboundTokenClaimName (string) --
The name of the custom claim field to check.
inboundTokenClaimValueType (string) --
The data type of the claim value to check for.
Use STRING if you want to find an exact match to a string you define.
Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.
authorizingClaimMatchValue (dict) --
Defines the value or values to match for and the relationship of the match.
claimMatchValue (dict) --
The value or values to match for.
matchValueString (string) --
The string value to match for.
matchValueStringList (list) --
An array of strings to check for a match.
(string) --
claimMatchOperator (string) --
Defines the relationship between the claim field value and the value or values you're matching for.
privateEndpoint (dict) --
The private endpoint configuration for a gateway target. Defines how the gateway connects to private resources in your VPC.
selfManagedLatticeResource (dict) --
Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The ARN or ID of the VPC Lattice resource configuration.
managedVpcResource (dict) --
Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
vpcIdentifier (string) --
The ID of the VPC that contains your private resource.
subnetIds (list) --
The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
(string) --
endpointIpAddressType (string) --
The IP address type for the resource configuration endpoint.
securityGroupIds (list) --
The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
(string) --
tags (dict) --
Tags to apply to the managed VPC Lattice resource gateway.
(string) --
(string) --
routingDomain (string) --
An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
privateEndpointOverrides (list) --
The private endpoint overrides for the custom JWT authorizer configuration.
(dict) --
A mapping of a specific domain to a private endpoint for secure connectivity through a VPC Lattice resource configuration.
domain (string) --
The domain to override with a private endpoint.
privateEndpoint (dict) --
The private endpoint configuration for the specified domain.
selfManagedLatticeResource (dict) --
Configuration for connecting to a private resource using a self-managed VPC Lattice resource configuration.
resourceConfigurationIdentifier (string) --
The ARN or ID of the VPC Lattice resource configuration.
managedVpcResource (dict) --
Configuration for connecting to a private resource using a managed VPC Lattice resource. The gateway creates and manages the VPC Lattice resources on your behalf.
vpcIdentifier (string) --
The ID of the VPC that contains your private resource.
subnetIds (list) --
The subnet IDs within the VPC where the VPC Lattice resource gateway is placed.
(string) --
endpointIpAddressType (string) --
The IP address type for the resource configuration endpoint.
securityGroupIds (list) --
The security group IDs to associate with the VPC Lattice resource gateway. If not specified, the default security group for the VPC is used.
(string) --
tags (dict) --
Tags to apply to the managed VPC Lattice resource gateway.
(string) --
(string) --
routingDomain (string) --
An intermediate domain to use as the resource configuration endpoint instead of the actual target domain. Use this when you want to route traffic through an intermediate component such as a VPC endpoint or internal load balancer. For more information, see xref:lattice-vpc-egress-routing-domain[Route traffic through an intermediate domain].
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role associated with the created payment manager.
workloadIdentityDetails (dict) --
The information about the workload identity.
workloadIdentityArn (string) --
The ARN associated with the workload identity.
createdAt (datetime) --
The timestamp when the payment manager was created.
status (string) --
The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
tags (dict) --
The tags associated with the created payment manager.
(string) --
(string) --
Retrieves information about a specific payment connector.
See also: AWS API Documentation
Request Syntax
client.get_payment_connector(
paymentManagerId='string',
paymentConnectorId='string'
)
string
[REQUIRED]
The unique identifier of the parent payment manager.
string
[REQUIRED]
The unique identifier of the payment connector to retrieve.
dict
Response Syntax
{
'paymentConnectorId': 'string',
'name': 'string',
'description': 'string',
'type': 'CoinbaseCDP'|'StripePrivy',
'credentialProviderConfigurations': [
{
'coinbaseCDP': {
'credentialProviderArn': 'string'
},
'stripePrivy': {
'credentialProviderArn': 'string'
}
},
],
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'
}
Response Structure
(dict) --
paymentConnectorId (string) --
The unique identifier of the payment connector.
name (string) --
The name of the payment connector.
description (string) --
The description of the payment connector.
type (string) --
The type of the payment connector, which determines the payment provider integration.
credentialProviderConfigurations (list) --
The credential provider configurations for the payment connector.
(dict) --
The credential provider configuration for a payment connector. Specifies the payment provider type and its associated credential provider.
coinbaseCDP (dict) --
The credential provider configuration for a Coinbase CDP payment connector.
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
stripePrivy (dict) --
The credential provider configuration for a Stripe Privy payment connector.
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.
createdAt (datetime) --
The timestamp when the payment connector was created.
lastUpdatedAt (datetime) --
The timestamp when the payment connector was last updated.
status (string) --
The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
Lists all payment managers in the account.
See also: AWS API Documentation
Request Syntax
client.list_payment_managers(
maxResults=123,
nextToken='string'
)
integer
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
string
If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
dict
Response Syntax
{
'paymentManagers': [
{
'paymentManagerArn': 'string',
'paymentManagerId': 'string',
'name': 'string',
'description': 'string',
'authorizerType': 'CUSTOM_JWT'|'AWS_IAM',
'roleArn': 'string',
'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
paymentManagers (list) --
The list of payment manager summaries. For details about the fields in each summary, see the PaymentManagerSummary data type.
(dict) --
Contains summary information about a payment manager.
paymentManagerArn (string) --
The Amazon Resource Name (ARN) of the payment manager.
paymentManagerId (string) --
The unique identifier of the payment manager.
name (string) --
The name of the payment manager.
description (string) --
The description of the payment manager.
authorizerType (string) --
The type of authorizer used by the payment manager.
CUSTOM_JWT - Authorize with a bearer token.
AWS_IAM - Authorize with your Amazon Web Services IAM credentials.
roleArn (string) --
The Amazon Resource Name (ARN) of the IAM role associated with the payment manager.
status (string) --
The current status of the payment manager. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.
createdAt (datetime) --
The timestamp when the payment manager was created.
lastUpdatedAt (datetime) --
The timestamp when the payment manager was last updated.
nextToken (string) --
If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.