Amazon Bedrock AgentCore Control

2026/11/19 - Amazon Bedrock AgentCore Control - 6 updated api methods

Changes  Adds the AWS Billing x402 payment type to ProcessPayment. Agents can purchase x402-enabled AWS Marketplace products and have the charges billed to the AWS account, without a wallet. Requests use the service-managed payment instrument ID aws.agentcorepayments.awsbilling.v1.

CreateCapacityProvider (updated) Link ¶
Changes (request)
{'computeConfiguration': {'ec2Configuration': {'launchTemplateSource': {'launchParameters': {'cpuOptions': {'nestedVirtualization': 'ENABLED '
                                                                                                                                    '| '
                                                                                                                                    'DISABLED'}}}}}}

Creates a capacity provider. A capacity provider defines the Amazon EC2 infrastructure for AgentCore Runtime, including the operating system, allowed instance types, networking, and storage. It also specifies the IAM permissions that AgentCore uses to manage those instances.

The capacity provider name must be unique within your account. After you create the capacity provider, it enters a CREATING state and transitions to READY when it is available for use.

See also: AWS API Documentation

Request Syntax

client.create_capacity_provider(
    name='string',
    description='string',
    permissionsConfiguration={
        'capacityProviderOperatorRoleArn': 'string'
    },
    clientToken='string',
    tags={
        'string': 'string'
    },
    computeConfiguration={
        'ec2Configuration': {
            'launchTemplateSource': {
                'launchParameters': {
                    'operatingSystem': 'LINUX_X86_64'|'LINUX_ARM64',
                    'instanceRequirements': {
                        'allowedInstanceTypes': [
                            'string',
                        ]
                    },
                    'ephemeralVolumes': [
                        {
                            'deviceName': 'string',
                            'virtualName': 'string',
                            'ebs': {
                                'volumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                                'iops': 123,
                                'throughput': 123,
                                'encrypted': True|False,
                                'kmsKeyId': 'string',
                                'snapshotId': 'string',
                                'volumeSize': 123,
                                'volumeInitializationRate': 123,
                                'ebsCardIndex': 123
                            }
                        },
                    ],
                    'monitoring': 'BASIC'|'DETAILED',
                    'licenseSpecifications': [
                        {
                            'licenseConfigurationArn': 'string'
                        },
                    ],
                    'capacityReservationSpecification': {
                        'capacityReservationPreference': 'capacity-reservations-only'|'open'|'none',
                        'capacityReservationTarget': {
                            'capacityReservationId': 'string',
                            'capacityReservationResourceGroupArn': 'string'
                        }
                    },
                    'sshKeyName': 'string',
                    'instanceProfileArn': 'string',
                    'propagatedTags': {
                        'string': 'string'
                    },
                    'cpuOptions': {
                        'nestedVirtualization': 'ENABLED'|'DISABLED'
                    }
                }
            },
            'vpcConfiguration': {
                'subnets': [
                    'string',
                ],
                'securityGroups': [
                    'string',
                ]
            },
            'volumes': [
                {
                    'ebsConfiguration': {
                        'name': 'string',
                        'sizeGiB': 123,
                        'volumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                        'iops': 123,
                        'throughput': 123,
                        'encrypted': True|False,
                        'kmsKeyId': 'string',
                        'snapshotId': 'string'
                    }
                },
            ],
            'lifecycleConfiguration': {
                'idleInstanceTimeout': 123,
                'maxLifetime': 123
            },
            'rootVolume': {
                'volumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                'iops': 123,
                'throughput': 123,
                'encrypted': True|False,
                'kmsKeyId': 'string',
                'freeSpaceGiB': 123
            }
        }
    }
)
type name:

string

param name:

[REQUIRED]

The name of the capacity provider. The name must be unique within your account.

type description:

string

param description:

An optional description of the capacity provider. If you don't specify a description, the service creates the capacity provider without one.

type permissionsConfiguration:

dict

param permissionsConfiguration:

[REQUIRED]

The permissions configuration for the capacity provider. This specifies the IAM role that AgentCore uses to manage the Amazon EC2 instances on your behalf.

  • capacityProviderOperatorRoleArn (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the IAM role that AgentCore assumes to manage the capacity provider, including launching, tagging, and terminating instances and their network interfaces. We recommend scoping this role to the minimum permissions that your workloads require.

type clientToken:

string

param clientToken:

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.

type tags:

dict

param tags:

A map of tag keys and values to associate with the capacity provider. If you don't specify tags, the capacity provider is created with no tags.

  • (string) --

    • (string) --

type computeConfiguration:

dict

param computeConfiguration:

[REQUIRED]

The compute configuration for the capacity provider. This defines the Amazon EC2 compute resources used to launch instances: the operating system, allowed instance types, networking, and storage.

  • ec2Configuration (dict) --

    The Amazon EC2 compute configuration for the capacity provider.

    • launchTemplateSource (dict) -- [REQUIRED]

      The source of the launch template configuration that defines how instances are launched.

      • launchParameters (dict) --

        The parameters that AgentCore uses to create the launch template.

        • operatingSystem (string) -- [REQUIRED]

          The operating system and CPU architecture for the instances.

        • instanceRequirements (dict) -- [REQUIRED]

          The requirements that determine which instance types can be launched.

          • allowedInstanceTypes (list) -- [REQUIRED]

            The list of allowed instance types. You can specify up to 30 instance types.

            • (string) --

        • ephemeralVolumes (list) --

          The block device mappings for instance store (ephemeral) volumes. You can specify up to five mappings.

          • (dict) --

            A block device mapping for an instance store (ephemeral) volume.

            • deviceName (string) --

              The device name, for example /dev/sdh or xvdh.

            • virtualName (string) --

              The virtual device name ( ephemeralN). Instance store volumes are numbered starting from 0. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

            • ebs (dict) --

              The shared Amazon EBS performance and encryption properties for a volume. These properties are common across the different volume configurations for a capacity provider.

              • volumeType (string) --

                The Amazon EBS volume type. If you do not specify a type, the default is gp3.

              • iops (integer) --

                The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000.

              • throughput (integer) --

                The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s.

              • encrypted (boolean) --

                Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value.

              • kmsKeyId (string) --

                The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for Amazon EBS encryption.

              • snapshotId (string) --

                The ID of the snapshot.

              • volumeSize (integer) --

                The size of the volume, in GiB. You must specify either a snapshot ID or a volume size. Supported sizes: gp2, 1–16,384; gp3, 1–65,536; io1, 4–16,384; io2, 4–65,536.

              • volumeInitializationRate (integer) --

                The rate at which the volume is initialized after creation, in MiB/s. Supported only for volumes created from snapshots. Valid range: 100–300 MiB/s.

              • ebsCardIndex (integer) --

                The index of the Amazon EBS card. Applies to instances with multiple Amazon EBS cards.

        • monitoring (string) --

          The monitoring level for the instances.

        • licenseSpecifications (list) --

          The license configurations to associate with the instances. You can specify up to five configurations.

          • (dict) --

            A license configuration to associate with the instances.

            • licenseConfigurationArn (string) -- [REQUIRED]

              The Amazon Resource Name (ARN) of the license configuration.

        • capacityReservationSpecification (dict) --

          The Capacity Reservation targeting option for the instances.

          • capacityReservationPreference (string) --

            The Capacity Reservation preference for the instances.

          • capacityReservationTarget (dict) --

            The target Capacity Reservation or Capacity Reservation group for the instances.

            • capacityReservationId (string) --

              The ID of the Capacity Reservation in which to run the instances.

            • capacityReservationResourceGroupArn (string) --

              The Amazon Resource Name (ARN) of the Capacity Reservation resource group in which to run the instances.

        • sshKeyName (string) --

          The name of the SSH key pair to configure on the instances for SSH connectivity.

        • instanceProfileArn (string) --

          The Amazon Resource Name (ARN) of the IAM instance profile to associate with launched instances. If provided, this overrides the default instance profile.

        • propagatedTags (dict) --

          The tags to propagate to all Amazon EC2 resources (instances, volumes, and network interfaces) that the capacity provider creates.

          • (string) --

            • (string) --

        • cpuOptions (dict) --

          The central processing unit (CPU) options for the instances that the capacity provider launches.

          • nestedVirtualization (string) --

            Specifies whether your agents can use hardware virtualization on their instances. The following values are possible:

            • ENABLED – Your agents can use hardware virtualization on their instances. To use this value, choose the LINUX_X86_64 operating system and instance types that support nested virtualization.

            • DISABLED – Your agents can't use hardware virtualization on their instances. This is the default.

    • vpcConfiguration (dict) -- [REQUIRED]

      The VPC configuration for launching instances, including subnets and security groups.

      • subnets (list) -- [REQUIRED]

        The IDs of the subnets in which to launch instances. You must specify at least one subnet.

        • (string) --

      • securityGroups (list) -- [REQUIRED]

        The IDs of the security groups to associate with the instances. You must specify at least one security group.

        • (string) --

    • volumes (list) --

      The named persistent Amazon EBS volumes for the capacity provider. A capacity provider can define up to five volumes.

      • (dict) --

        The configuration for a persistent volume attached to a capacity provider. This structure defines the storage backing for the persistent volumes used by agents that run on capacity provider instances.

        • ebsConfiguration (dict) --

          The configuration for an Amazon EBS-backed persistent volume.

          • name (string) -- [REQUIRED]

            The logical name of the volume. Use this name to reference the volume when you mount it into an agent runtime.

          • sizeGiB (integer) -- [REQUIRED]

            The size of the volume, in GiB.

          • volumeType (string) --

            The Amazon EBS volume type. If you do not specify a type, the default is gp3.

          • iops (integer) --

            The number of IOPS to provision. Valid only for gp3, io1, and io2 volumes.

          • throughput (integer) --

            The throughput, in MiB/s. Valid only for gp3 volumes.

          • encrypted (boolean) --

            Specifies whether to encrypt the volume. If true, the service encrypts the volume with the KMS key that you specify in kmsKeyId, or the default KMS key for Amazon EBS if you do not specify one. The default is true.

          • kmsKeyId (string) --

            The identifier of the KMS key to use for encryption.

          • snapshotId (string) --

            An optional Amazon EBS snapshot ID. If provided, the volume is initialized from this snapshot the first time it is created. On subsequent restarts, the existing volume is used and the snapshot is ignored.

    • lifecycleConfiguration (dict) --

      The lifecycle configuration for instances in the capacity provider.

      • idleInstanceTimeout (integer) --

        The number of seconds an instance can remain idle before it is stopped. An instance is considered idle when all of its agents are idle. The default is 900 seconds (15 minutes).

      • maxLifetime (integer) --

        The maximum lifetime of an instance, in seconds. When an instance reaches this limit, the service terminates it regardless of activity. The default is 28800 seconds (8 hours). The maximum is 1209600 seconds (14 days).

    • rootVolume (dict) --

      The configuration for the instance root volume. Specify the amount of free space to guarantee and, optionally, the Amazon EBS performance and encryption settings. The device name and delete-on-termination behavior are not configurable.

      • volumeType (string) --

        The Amazon EBS volume type. If you do not specify a type, the default is gp3.

      • iops (integer) --

        The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000.

      • throughput (integer) --

        The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s.

      • encrypted (boolean) --

        Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value.

      • kmsKeyId (string) --

        The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for Amazon EBS encryption.

      • freeSpaceGiB (integer) --

        The free space guaranteed on the root volume, in GiB. AgentCore adds the operating system overhead on top of this value. The default is 8 GiB.

rtype:

dict

returns:

Response Syntax

{
    'capacityProviderId': 'string',
    'capacityProviderArn': 'string',
    'name': 'string',
    'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED'
}

Response Structure

  • (dict) --

    • capacityProviderId (string) --

      The unique identifier of the created capacity provider.

    • capacityProviderArn (string) --

      The Amazon Resource Name (ARN) of the capacity provider.

    • name (string) --

      The name of the capacity provider.

    • status (string) --

      The current status of the capacity provider. For possible values, see CapacityProviderStatus.

CreatePaymentConnector (updated) Link ¶
Changes (both)
{'credentialProviderConfigurations': {'awsBilling': {'iamRoleArn': 'string'}},
 'type': {'AwsBilling'}}

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'|'AwsBilling',
    credentialProviderConfigurations=[
        {
            'coinbaseCDP': {
                'credentialProviderArn': 'string'
            },
            'stripePrivy': {
                'credentialProviderArn': 'string'
            },
            'awsBilling': {
                'iamRoleArn': 'string'
            }
        },
    ],
    provisionMode='MANUAL'|'QUICK_CREATE',
    clientToken='string'
)
type paymentManagerId:

string

param paymentManagerId:

[REQUIRED]

The unique identifier of the payment manager to create the connector for.

type name:

string

param name:

[REQUIRED]

The name of the payment connector.

type description:

string

param description:

A description of the payment connector.

type type:

string

param type:

[REQUIRED]

The type of payment connector, which determines the payment provider integration.

type credentialProviderConfigurations:

list

param credentialProviderConfigurations:

The credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.

For an AwsBilling payment connector, omit this parameter or specify an empty list. The service uses the AWS Marketplace service-linked role in your account, which must exist before you create the connector, and you must have permission to call iam:GetRole on it.

  • (dict) --

    The configuration for a payment connector. Specifies the payment provider type and either its associated credential provider or, for an AWS Billing payment connector, its billing configuration.

    • 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.

    • awsBilling (dict) --

      The configuration for an AWS Billing payment connector. The service sets this configuration when it creates the connector and returns it in responses. Don't specify it when you create an AWS Billing payment connector.

      • iamRoleArn (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) of the AWS Marketplace service-linked role in the account that owns the payment manager. The service sets this value when it creates the connector.

type provisionMode:

string

param provisionMode:

The provision mode for creating the payment connector. If you don't specify a value, the default is MANUAL.

  • MANUAL - You provide the credential provider configurations directly.

  • QUICK_CREATE - The service orchestrates OAuth consent and provisions the credential provider for you.

type clientToken:

string

param clientToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'paymentConnectorId': 'string',
    'paymentManagerId': 'string',
    'name': 'string',
    'type': 'CoinbaseCDP'|'StripePrivy'|'AwsBilling',
    'credentialProviderConfigurations': [
        {
            'coinbaseCDP': {
                'credentialProviderArn': 'string'
            },
            'stripePrivy': {
                'credentialProviderArn': 'string'
            },
            'awsBilling': {
                'iamRoleArn': 'string'
            }
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED'|'PENDING_AUTHENTICATION'|'PROVISIONING'|'AUTHENTICATION_EXPIRED'|'AUTHENTICATION_FAILED',
    'authorizationUrl': 'string'
}

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 configuration for a payment connector. Specifies the payment provider type and either its associated credential provider or, for an AWS Billing payment connector, its billing configuration.

        • 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.

        • awsBilling (dict) --

          The configuration for an AWS Billing payment connector. The service sets this configuration when it creates the connector and returns it in responses. Don't specify it when you create an AWS Billing payment connector.

          • iamRoleArn (string) --

            The Amazon Resource Name (ARN) of the AWS Marketplace service-linked role in the account that owns the payment manager. The service sets this value when it creates the connector.

    • 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.

    • authorizationUrl (string) --

      The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is PENDING_AUTHENTICATION.

GetCapacityProvider (updated) Link ¶
Changes (response)
{'computeConfiguration': {'ec2Configuration': {'launchTemplateSource': {'launchParameters': {'cpuOptions': {'nestedVirtualization': 'ENABLED '
                                                                                                                                    '| '
                                                                                                                                    'DISABLED'}}}}}}

Retrieves information about a capacity provider, including its status, permissions configuration, and compute configuration.

See also: AWS API Documentation

Request Syntax

client.get_capacity_provider(
    capacityProviderId='string'
)
type capacityProviderId:

string

param capacityProviderId:

[REQUIRED]

The unique identifier of the capacity provider.

rtype:

dict

returns:

Response Syntax

{
    'capacityProviderId': 'string',
    'capacityProviderArn': 'string',
    'name': 'string',
    'status': 'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED',
    'description': 'string',
    'statusCode': 'VALIDATION_ERROR'|'QUOTA_EXCEEDED'|'THROTTLED'|'INTERNAL_SERVER_EXCEPTION',
    'statusReason': 'string',
    'permissionsConfiguration': {
        'capacityProviderOperatorRoleArn': 'string'
    },
    'computeConfiguration': {
        'ec2Configuration': {
            'launchTemplateSource': {
                'launchParameters': {
                    'operatingSystem': 'LINUX_X86_64'|'LINUX_ARM64',
                    'instanceRequirements': {
                        'allowedInstanceTypes': [
                            'string',
                        ]
                    },
                    'ephemeralVolumes': [
                        {
                            'deviceName': 'string',
                            'virtualName': 'string',
                            'ebs': {
                                'volumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                                'iops': 123,
                                'throughput': 123,
                                'encrypted': True|False,
                                'kmsKeyId': 'string',
                                'snapshotId': 'string',
                                'volumeSize': 123,
                                'volumeInitializationRate': 123,
                                'ebsCardIndex': 123
                            }
                        },
                    ],
                    'monitoring': 'BASIC'|'DETAILED',
                    'licenseSpecifications': [
                        {
                            'licenseConfigurationArn': 'string'
                        },
                    ],
                    'capacityReservationSpecification': {
                        'capacityReservationPreference': 'capacity-reservations-only'|'open'|'none',
                        'capacityReservationTarget': {
                            'capacityReservationId': 'string',
                            'capacityReservationResourceGroupArn': 'string'
                        }
                    },
                    'sshKeyName': 'string',
                    'instanceProfileArn': 'string',
                    'propagatedTags': {
                        'string': 'string'
                    },
                    'cpuOptions': {
                        'nestedVirtualization': 'ENABLED'|'DISABLED'
                    }
                }
            },
            'vpcConfiguration': {
                'subnets': [
                    'string',
                ],
                'securityGroups': [
                    'string',
                ]
            },
            'volumes': [
                {
                    'ebsConfiguration': {
                        'name': 'string',
                        'sizeGiB': 123,
                        'volumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                        'iops': 123,
                        'throughput': 123,
                        'encrypted': True|False,
                        'kmsKeyId': 'string',
                        'snapshotId': 'string'
                    }
                },
            ],
            'lifecycleConfiguration': {
                'idleInstanceTimeout': 123,
                'maxLifetime': 123
            },
            'rootVolume': {
                'volumeType': 'standard'|'io1'|'io2'|'gp2'|'sc1'|'st1'|'gp3',
                'iops': 123,
                'throughput': 123,
                'encrypted': True|False,
                'kmsKeyId': 'string',
                'freeSpaceGiB': 123
            }
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • capacityProviderId (string) --

      The unique identifier of the capacity provider.

    • capacityProviderArn (string) --

      The Amazon Resource Name (ARN) of the capacity provider.

    • name (string) --

      The name of the capacity provider.

    • status (string) --

      The current status of the capacity provider. For possible values, see CapacityProviderStatus.

    • description (string) --

      The description of the capacity provider, if one was provided.

    • statusCode (string) --

      A reason code for a capacity provider that is not in the READY state. Use this code for programmatic error handling.

    • statusReason (string) --

      A human-readable message that describes why the capacity provider is not in the READY state. Because these messages can change, use statusCode for programmatic error handling.

    • permissionsConfiguration (dict) --

      The permissions configuration for the capacity provider.

      • capacityProviderOperatorRoleArn (string) --

        The Amazon Resource Name (ARN) of the IAM role that AgentCore assumes to manage the capacity provider, including launching, tagging, and terminating instances and their network interfaces. We recommend scoping this role to the minimum permissions that your workloads require.

    • computeConfiguration (dict) --

      The compute configuration for the capacity provider.

      • ec2Configuration (dict) --

        The Amazon EC2 compute configuration for the capacity provider.

        • launchTemplateSource (dict) --

          The source of the launch template configuration that defines how instances are launched.

          • launchParameters (dict) --

            The parameters that AgentCore uses to create the launch template.

            • operatingSystem (string) --

              The operating system and CPU architecture for the instances.

            • instanceRequirements (dict) --

              The requirements that determine which instance types can be launched.

              • allowedInstanceTypes (list) --

                The list of allowed instance types. You can specify up to 30 instance types.

                • (string) --

            • ephemeralVolumes (list) --

              The block device mappings for instance store (ephemeral) volumes. You can specify up to five mappings.

              • (dict) --

                A block device mapping for an instance store (ephemeral) volume.

                • deviceName (string) --

                  The device name, for example /dev/sdh or xvdh.

                • virtualName (string) --

                  The virtual device name ( ephemeralN). Instance store volumes are numbered starting from 0. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

                • ebs (dict) --

                  The shared Amazon EBS performance and encryption properties for a volume. These properties are common across the different volume configurations for a capacity provider.

                  • volumeType (string) --

                    The Amazon EBS volume type. If you do not specify a type, the default is gp3.

                  • iops (integer) --

                    The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000.

                  • throughput (integer) --

                    The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s.

                  • encrypted (boolean) --

                    Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value.

                  • kmsKeyId (string) --

                    The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for Amazon EBS encryption.

                  • snapshotId (string) --

                    The ID of the snapshot.

                  • volumeSize (integer) --

                    The size of the volume, in GiB. You must specify either a snapshot ID or a volume size. Supported sizes: gp2, 1–16,384; gp3, 1–65,536; io1, 4–16,384; io2, 4–65,536.

                  • volumeInitializationRate (integer) --

                    The rate at which the volume is initialized after creation, in MiB/s. Supported only for volumes created from snapshots. Valid range: 100–300 MiB/s.

                  • ebsCardIndex (integer) --

                    The index of the Amazon EBS card. Applies to instances with multiple Amazon EBS cards.

            • monitoring (string) --

              The monitoring level for the instances.

            • licenseSpecifications (list) --

              The license configurations to associate with the instances. You can specify up to five configurations.

              • (dict) --

                A license configuration to associate with the instances.

                • licenseConfigurationArn (string) --

                  The Amazon Resource Name (ARN) of the license configuration.

            • capacityReservationSpecification (dict) --

              The Capacity Reservation targeting option for the instances.

              • capacityReservationPreference (string) --

                The Capacity Reservation preference for the instances.

              • capacityReservationTarget (dict) --

                The target Capacity Reservation or Capacity Reservation group for the instances.

                • capacityReservationId (string) --

                  The ID of the Capacity Reservation in which to run the instances.

                • capacityReservationResourceGroupArn (string) --

                  The Amazon Resource Name (ARN) of the Capacity Reservation resource group in which to run the instances.

            • sshKeyName (string) --

              The name of the SSH key pair to configure on the instances for SSH connectivity.

            • instanceProfileArn (string) --

              The Amazon Resource Name (ARN) of the IAM instance profile to associate with launched instances. If provided, this overrides the default instance profile.

            • propagatedTags (dict) --

              The tags to propagate to all Amazon EC2 resources (instances, volumes, and network interfaces) that the capacity provider creates.

              • (string) --

                • (string) --

            • cpuOptions (dict) --

              The central processing unit (CPU) options for the instances that the capacity provider launches.

              • nestedVirtualization (string) --

                Specifies whether your agents can use hardware virtualization on their instances. The following values are possible:

                • ENABLED – Your agents can use hardware virtualization on their instances. To use this value, choose the LINUX_X86_64 operating system and instance types that support nested virtualization.

                • DISABLED – Your agents can't use hardware virtualization on their instances. This is the default.

        • vpcConfiguration (dict) --

          The VPC configuration for launching instances, including subnets and security groups.

          • subnets (list) --

            The IDs of the subnets in which to launch instances. You must specify at least one subnet.

            • (string) --

          • securityGroups (list) --

            The IDs of the security groups to associate with the instances. You must specify at least one security group.

            • (string) --

        • volumes (list) --

          The named persistent Amazon EBS volumes for the capacity provider. A capacity provider can define up to five volumes.

          • (dict) --

            The configuration for a persistent volume attached to a capacity provider. This structure defines the storage backing for the persistent volumes used by agents that run on capacity provider instances.

            • ebsConfiguration (dict) --

              The configuration for an Amazon EBS-backed persistent volume.

              • name (string) --

                The logical name of the volume. Use this name to reference the volume when you mount it into an agent runtime.

              • sizeGiB (integer) --

                The size of the volume, in GiB.

              • volumeType (string) --

                The Amazon EBS volume type. If you do not specify a type, the default is gp3.

              • iops (integer) --

                The number of IOPS to provision. Valid only for gp3, io1, and io2 volumes.

              • throughput (integer) --

                The throughput, in MiB/s. Valid only for gp3 volumes.

              • encrypted (boolean) --

                Specifies whether to encrypt the volume. If true, the service encrypts the volume with the KMS key that you specify in kmsKeyId, or the default KMS key for Amazon EBS if you do not specify one. The default is true.

              • kmsKeyId (string) --

                The identifier of the KMS key to use for encryption.

              • snapshotId (string) --

                An optional Amazon EBS snapshot ID. If provided, the volume is initialized from this snapshot the first time it is created. On subsequent restarts, the existing volume is used and the snapshot is ignored.

        • lifecycleConfiguration (dict) --

          The lifecycle configuration for instances in the capacity provider.

          • idleInstanceTimeout (integer) --

            The number of seconds an instance can remain idle before it is stopped. An instance is considered idle when all of its agents are idle. The default is 900 seconds (15 minutes).

          • maxLifetime (integer) --

            The maximum lifetime of an instance, in seconds. When an instance reaches this limit, the service terminates it regardless of activity. The default is 28800 seconds (8 hours). The maximum is 1209600 seconds (14 days).

        • rootVolume (dict) --

          The configuration for the instance root volume. Specify the amount of free space to guarantee and, optionally, the Amazon EBS performance and encryption settings. The device name and delete-on-termination behavior are not configurable.

          • volumeType (string) --

            The Amazon EBS volume type. If you do not specify a type, the default is gp3.

          • iops (integer) --

            The number of IOPS to provision. For gp3, io1, and io2 volumes, this is the number of IOPS provisioned for the volume. For gp2 volumes, this sets the baseline IOPS performance. It also controls the rate at which the volume accumulates I/O credits for bursting. Supported values: gp3, 3,000–80,000; io1, 100–64,000; io2, 100–256,000.

          • throughput (integer) --

            The throughput to provision, in MiB/s. Valid only for gp3 volumes. Valid range: 125–2,000 MiB/s.

          • encrypted (boolean) --

            Specifies whether to encrypt the volume. Encrypted volumes can be attached only to instances that support Amazon EBS encryption. If you create a volume from a snapshot, you cannot specify an encryption value.

          • kmsKeyId (string) --

            The identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for Amazon EBS encryption.

          • freeSpaceGiB (integer) --

            The free space guaranteed on the root volume, in GiB. AgentCore adds the operating system overhead on top of this value. The default is 8 GiB.

    • createdAt (datetime) --

      The timestamp when the capacity provider was created.

    • lastUpdatedAt (datetime) --

      The timestamp when the capacity provider was last updated.

GetPaymentConnector (updated) Link ¶
Changes (response)
{'credentialProviderConfigurations': {'awsBilling': {'iamRoleArn': 'string'}},
 'type': {'AwsBilling'}}

Retrieves information about a specific payment connector.

See also: AWS API Documentation

Request Syntax

client.get_payment_connector(
    paymentManagerId='string',
    paymentConnectorId='string'
)
type paymentManagerId:

string

param paymentManagerId:

[REQUIRED]

The unique identifier of the parent payment manager.

type paymentConnectorId:

string

param paymentConnectorId:

[REQUIRED]

The unique identifier of the payment connector to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'paymentConnectorId': 'string',
    'name': 'string',
    'description': 'string',
    'type': 'CoinbaseCDP'|'StripePrivy'|'AwsBilling',
    'provisionMode': 'MANUAL'|'QUICK_CREATE',
    'credentialProviderConfigurations': [
        {
            'coinbaseCDP': {
                'credentialProviderArn': 'string'
            },
            'stripePrivy': {
                'credentialProviderArn': 'string'
            },
            'awsBilling': {
                'iamRoleArn': 'string'
            }
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED'|'PENDING_AUTHENTICATION'|'PROVISIONING'|'AUTHENTICATION_EXPIRED'|'AUTHENTICATION_FAILED',
    'authorizationUrl': 'string',
    'credentialsUpdatedAt': datetime(2015, 1, 1)
}

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.

    • provisionMode (string) --

      Specifies how the payment connector was provisioned. Payment connectors that were created before this field was available return MANUAL.

      • MANUAL - You provided the credential provider configurations, so you own the credentials. Rotate them with the payment provider, then call UpdatePaymentCredentialProvider.

      • QUICK_CREATE - AgentCore provisioned the credential provider for you, so the credentials are service-managed. You can rotate them with RotatePaymentConnectorCredentials.

    • credentialProviderConfigurations (list) --

      The credential provider configurations for the payment connector.

      • (dict) --

        The configuration for a payment connector. Specifies the payment provider type and either its associated credential provider or, for an AWS Billing payment connector, its billing configuration.

        • 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.

        • awsBilling (dict) --

          The configuration for an AWS Billing payment connector. The service sets this configuration when it creates the connector and returns it in responses. Don't specify it when you create an AWS Billing payment connector.

          • iamRoleArn (string) --

            The Amazon Resource Name (ARN) of the AWS Marketplace service-linked role in the account that owns the payment manager. The service sets this value when it creates the connector.

    • 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.

    • authorizationUrl (string) --

      The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is PENDING_AUTHENTICATION.

    • credentialsUpdatedAt (datetime) --

      The timestamp when the payment connector's current service-managed credentials took effect. It is first set when the credentials are provisioned and is updated by each rotation. This field is present only for payment connectors with a provisionMode of QUICK_CREATE.

ListPaymentConnectors (updated) Link ¶
Changes (response)
{'paymentConnectors': {'type': {'AwsBilling'}}}

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'
)
type paymentManagerId:

string

param paymentManagerId:

[REQUIRED]

The unique identifier of the payment manager whose connectors to list.

type maxResults:

integer

param maxResults:

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.

type nextToken:

string

param nextToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'paymentConnectors': [
        {
            'paymentConnectorId': 'string',
            'name': 'string',
            'type': 'CoinbaseCDP'|'StripePrivy'|'AwsBilling',
            'provisionMode': 'MANUAL'|'QUICK_CREATE',
            'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED'|'PENDING_AUTHENTICATION'|'PROVISIONING'|'AUTHENTICATION_EXPIRED'|'AUTHENTICATION_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.

        • provisionMode (string) --

          Specifies how the payment connector was provisioned. Payment connectors that were created before this field was available return MANUAL.

          • MANUAL - You provided the credential provider configurations, so you own the credentials.

          • QUICK_CREATE - AgentCore provisioned the credential provider for you, so the credentials are service-managed and you can rotate them with RotatePaymentConnectorCredentials.

        • 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.

UpdatePaymentConnector (updated) Link ¶
Changes (both)
{'credentialProviderConfigurations': {'awsBilling': {'iamRoleArn': 'string'}},
 'type': {'AwsBilling'}}

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'|'AwsBilling',
    credentialProviderConfigurations=[
        {
            'coinbaseCDP': {
                'credentialProviderArn': 'string'
            },
            'stripePrivy': {
                'credentialProviderArn': 'string'
            },
            'awsBilling': {
                'iamRoleArn': 'string'
            }
        },
    ],
    clientToken='string'
)
type paymentManagerId:

string

param paymentManagerId:

[REQUIRED]

The unique identifier of the parent payment manager.

type paymentConnectorId:

string

param paymentConnectorId:

[REQUIRED]

The unique identifier of the payment connector to update.

type description:

string

param description:

The updated description of the payment connector.

type type:

string

param type:

The updated type of the payment connector.

type credentialProviderConfigurations:

list

param credentialProviderConfigurations:

The updated credential provider configurations for the payment connector.

  • (dict) --

    The configuration for a payment connector. Specifies the payment provider type and either its associated credential provider or, for an AWS Billing payment connector, its billing configuration.

    • 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.

    • awsBilling (dict) --

      The configuration for an AWS Billing payment connector. The service sets this configuration when it creates the connector and returns it in responses. Don't specify it when you create an AWS Billing payment connector.

      • iamRoleArn (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) of the AWS Marketplace service-linked role in the account that owns the payment manager. The service sets this value when it creates the connector.

type clientToken:

string

param clientToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'paymentConnectorId': 'string',
    'paymentManagerId': 'string',
    'name': 'string',
    'type': 'CoinbaseCDP'|'StripePrivy'|'AwsBilling',
    'credentialProviderConfigurations': [
        {
            'coinbaseCDP': {
                'credentialProviderArn': 'string'
            },
            'stripePrivy': {
                'credentialProviderArn': 'string'
            },
            'awsBilling': {
                'iamRoleArn': 'string'
            }
        },
    ],
    'lastUpdatedAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'|'AWS_MARKETPLACE_SUBSCRIPTION_REQUIRED'|'PENDING_AUTHENTICATION'|'PROVISIONING'|'AUTHENTICATION_EXPIRED'|'AUTHENTICATION_FAILED',
    'authorizationUrl': 'string'
}

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 configuration for a payment connector. Specifies the payment provider type and either its associated credential provider or, for an AWS Billing payment connector, its billing configuration.

        • 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.

        • awsBilling (dict) --

          The configuration for an AWS Billing payment connector. The service sets this configuration when it creates the connector and returns it in responses. Don't specify it when you create an AWS Billing payment connector.

          • iamRoleArn (string) --

            The Amazon Resource Name (ARN) of the AWS Marketplace service-linked role in the account that owns the payment manager. The service sets this value when it creates the connector.

    • 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.

    • authorizationUrl (string) --

      The URL that the user must open to complete OAuth consent. This field is only present when the payment connector status is PENDING_AUTHENTICATION.