AgentRegistryControl / Client / update_registry

update_registry¶

AgentRegistryControl.Client.update_registry(**kwargs)¶

Updates an existing registry. This operation uses PATCH semantics: specify only the fields you want to change, and omit the rest to leave them unchanged. Updates are applied asynchronously and the registry transitions to the UPDATING status while they are processed.

Request Syntax

response = client.update_registry(
    registryId='string',
    name='string',
    description={
        'optionalValue': 'string'
    },
    discoveryConfiguration={
        'authorizerConfiguration': {
            'optionalValue': {
                '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'
                                }
                            }
                        },
                    ]
                }
            }
        }
    },
    approvalConfiguration={
        'optionalValue': {
            'autoApprovalRules': [
                'APPROVE_ALL',
            ]
        }
    }
)

Parameters:

registryId (string) –
[REQUIRED]

The identifier of the registry to update (ARN or ID)
name (string) – The updated name of the registry
description (dict) –
The updated description of the registry
- optionalValue (string) –
  
  Description of the Resource
discoveryConfiguration (dict) –
The updated discovery configuration. Changing the discovery authorization can break existing consumers that rely on the previous authorization type.
- authorizerConfiguration (dict) –
  
  Authorization configuration for the registry, with PATCH semantics
  - optionalValue (dict) –
    
    The new authorizer configuration to set. Omit to leave the existing configuration unchanged.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: customJWTAuthorizer.
    - customJWTAuthorizer (dict) –
      
      Configuration for a custom JWT authorizer.
      - discoveryUrl (string) – [REQUIRED]
        
        The OpenID Connect discovery URL used to retrieve the identity provider’s metadata and signing keys.
      - allowedAudience (list) –
        
        The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
        
        (string) –
        
        An audience value that an inbound JWT must contain to be authorized.
      - allowedClients (list) –
        
        The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
        
        (string) –
        
        A client identifier that an inbound JWT must be issued to in order to be authorized.
      - allowedScopes (list) –
        
        The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
        
        (string) –
        
        A scope value that an inbound JWT must carry to be authorized.
      - customClaims (list) –
        
        Additional custom claim validations applied to the inbound JWT.
        
        (dict) –
        
        A validation rule applied to a single claim of an inbound JWT.
        
        inboundTokenClaimName (string) – [REQUIRED]
        
        The name of the claim in the inbound token to validate.
        
        inboundTokenClaimValueType (string) – [REQUIRED]
        
        The value type of the claim in the inbound token, either a string or an array of strings.
        
        authorizingClaimMatchValue (dict) – [REQUIRED]
        
        The value and match operator used to authorize the claim.
        
        claimMatchValue (dict) – [REQUIRED]
        
        The expected value or values that the claim is compared against.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: matchValueString, matchValueStringList.
        
        matchValueString (string) –
        
        A single string value to match the claim against.
        
        matchValueStringList (list) –
        
        A list of string values to match the claim against.
        
        (string) –
        
        A single value used to match a claim during JWT validation.
        
        claimMatchOperator (string) – [REQUIRED]
        
        The operator used to compare the claim value against the expected value.
      - privateEndpoint (dict) –
        
        The private endpoint used to reach the identity provider’s discovery URL over a private network path.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: selfManagedLatticeResource, managedVpcResource.
        
        selfManagedLatticeResource (dict) –
        
        A private endpoint backed by a self-managed VPC Lattice resource configuration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: resourceConfigurationIdentifier.
        
        resourceConfigurationIdentifier (string) –
        
        The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
        
        managedVpcResource (dict) –
        
        A private endpoint backed by a service-managed VPC resource.
        
        vpcIdentifier (string) – [REQUIRED]
        
        The identifier of the VPC in which the private endpoint is provisioned.
        
        subnetIds (list) – [REQUIRED]
        
        The identifiers of the subnets in which the private endpoint network interfaces are placed.
        
        (string) –
        
        Subnet identifier
        
        endpointIpAddressType (string) – [REQUIRED]
        
        The IP address type used by the private endpoint, either IPV4 or IPV6.
        
        securityGroupIds (list) –
        
        The identifiers of the security groups associated with the private endpoint network interfaces.
        
        (string) –
        
        The identifier of a security group.
        
        tags (dict) –
        
        A map of tag keys to tag values.
        
        (string) –
        
        Key of a tag.
        
        (string) –
        
        Value of a tag.
        
        routingDomain (string) –
        
        The routing domain used to resolve traffic through the private endpoint.
      - privateEndpointOverrides (list) –
        
        Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
        
        (dict) –
        
        A mapping of a domain to the private endpoint used to reach it.
        
        domain (string) – [REQUIRED]
        
        The domain name to which this private endpoint override applies.
        
        privateEndpoint (dict) – [REQUIRED]
        
        The private endpoint used to reach the specified domain.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: selfManagedLatticeResource, managedVpcResource.
        
        selfManagedLatticeResource (dict) –
        
        A private endpoint backed by a self-managed VPC Lattice resource configuration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: resourceConfigurationIdentifier.
        
        resourceConfigurationIdentifier (string) –
        
        The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
        
        managedVpcResource (dict) –
        
        A private endpoint backed by a service-managed VPC resource.
        
        vpcIdentifier (string) – [REQUIRED]
        
        The identifier of the VPC in which the private endpoint is provisioned.
        
        subnetIds (list) – [REQUIRED]
        
        The identifiers of the subnets in which the private endpoint network interfaces are placed.
        
        (string) –
        
        Subnet identifier
        
        endpointIpAddressType (string) – [REQUIRED]
        
        The IP address type used by the private endpoint, either IPV4 or IPV6.
        
        securityGroupIds (list) –
        
        The identifiers of the security groups associated with the private endpoint network interfaces.
        
        (string) –
        
        The identifier of a security group.
        
        tags (dict) –
        
        A map of tag keys to tag values.
        
        (string) –
        
        Key of a tag.
        
        (string) –
        
        Value of a tag.
        
        routingDomain (string) –
        
        The routing domain used to resolve traffic through the private endpoint.
approvalConfiguration (dict) –
The updated approval configuration. The change applies only to records that move to PENDING_APPROVAL after the update; records already in PENDING_APPROVAL are unaffected.
- optionalValue (dict) –
  
  The value to set for this field. Omit the wrapper to leave the field unchanged.
  - autoApprovalRules (list) –
    
    The rules that determine which registry records are automatically approved on submission. When omitted or empty, submitted records require manual review.
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'description': 'string',
    'registryId': 'string',
    'registryArn': 'string',
    'discoveryConfiguration': {
        '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'
                            }
                        }
                    },
                ]
            }
        },
        'authorizerType': 'CUSTOM_JWT'|'AWS_IAM'
    },
    'approvalConfiguration': {
        'autoApprovalRules': [
            'APPROVE_ALL',
        ]
    },
    'status': 'CREATING'|'READY'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED',
    'statusReason': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –

Response structure for updating a registry
- name (string) –
  
  The name of the registry
- description (string) –
  
  The description of the registry
- registryId (string) –
  
  The unique identifier of the registry
- registryArn (string) –
  
  The ARN of the registry
- discoveryConfiguration (dict) –
  
  Discovery configuration for the registry
  - authorizerConfiguration (dict) –
    
    The authorizer configuration for the registry. Required when authorizerType is CUSTOM_JWT.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: customJWTAuthorizer. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - customJWTAuthorizer (dict) –
      
      Configuration for a custom JWT authorizer.
      - discoveryUrl (string) –
        
        The OpenID Connect discovery URL used to retrieve the identity provider’s metadata and signing keys.
      - allowedAudience (list) –
        
        The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.
        
        (string) –
        
        An audience value that an inbound JWT must contain to be authorized.
      - allowedClients (list) –
        
        The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.
        
        (string) –
        
        A client identifier that an inbound JWT must be issued to in order to be authorized.
      - allowedScopes (list) –
        
        The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.
        
        (string) –
        
        A scope value that an inbound JWT must carry to be authorized.
      - customClaims (list) –
        
        Additional custom claim validations applied to the inbound JWT.
        
        (dict) –
        
        A validation rule applied to a single claim of an inbound JWT.
        
        inboundTokenClaimName (string) –
        
        The name of the claim in the inbound token to validate.
        
        inboundTokenClaimValueType (string) –
        
        The value type of the claim in the inbound token, either a string or an array of strings.
        
        authorizingClaimMatchValue (dict) –
        
        The value and match operator used to authorize the claim.
        
        claimMatchValue (dict) –
        
        The expected value or values that the claim is compared against.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: matchValueString, matchValueStringList. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        matchValueString (string) –
        
        A single string value to match the claim against.
        
        matchValueStringList (list) –
        
        A list of string values to match the claim against.
        
        (string) –
        
        A single value used to match a claim during JWT validation.
        
        claimMatchOperator (string) –
        
        The operator used to compare the claim value against the expected value.
      - privateEndpoint (dict) –
        
        The private endpoint used to reach the identity provider’s discovery URL over a private network path.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: selfManagedLatticeResource, managedVpcResource. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        selfManagedLatticeResource (dict) –
        
        A private endpoint backed by a self-managed VPC Lattice resource configuration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: resourceConfigurationIdentifier. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        resourceConfigurationIdentifier (string) –
        
        The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
        
        managedVpcResource (dict) –
        
        A private endpoint backed by a service-managed VPC resource.
        
        vpcIdentifier (string) –
        
        The identifier of the VPC in which the private endpoint is provisioned.
        
        subnetIds (list) –
        
        The identifiers of the subnets in which the private endpoint network interfaces are placed.
        
        (string) –
        
        Subnet identifier
        
        endpointIpAddressType (string) –
        
        The IP address type used by the private endpoint, either IPV4 or IPV6.
        
        securityGroupIds (list) –
        
        The identifiers of the security groups associated with the private endpoint network interfaces.
        
        (string) –
        
        The identifier of a security group.
        
        tags (dict) –
        
        A map of tag keys to tag values.
        
        (string) –
        
        Key of a tag.
        
        (string) –
        
        Value of a tag.
        
        routingDomain (string) –
        
        The routing domain used to resolve traffic through the private endpoint.
      - privateEndpointOverrides (list) –
        
        Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.
        
        (dict) –
        
        A mapping of a domain to the private endpoint used to reach it.
        
        domain (string) –
        
        The domain name to which this private endpoint override applies.
        
        privateEndpoint (dict) –
        
        The private endpoint used to reach the specified domain.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: selfManagedLatticeResource, managedVpcResource. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        selfManagedLatticeResource (dict) –
        
        A private endpoint backed by a self-managed VPC Lattice resource configuration.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: resourceConfigurationIdentifier. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        resourceConfigurationIdentifier (string) –
        
        The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.
        
        managedVpcResource (dict) –
        
        A private endpoint backed by a service-managed VPC resource.
        
        vpcIdentifier (string) –
        
        The identifier of the VPC in which the private endpoint is provisioned.
        
        subnetIds (list) –
        
        The identifiers of the subnets in which the private endpoint network interfaces are placed.
        
        (string) –
        
        Subnet identifier
        
        endpointIpAddressType (string) –
        
        The IP address type used by the private endpoint, either IPV4 or IPV6.
        
        securityGroupIds (list) –
        
        The identifiers of the security groups associated with the private endpoint network interfaces.
        
        (string) –
        
        The identifier of a security group.
        
        tags (dict) –
        
        A map of tag keys to tag values.
        
        (string) –
        
        Key of a tag.
        
        (string) –
        
        Value of a tag.
        
        routingDomain (string) –
        
        The routing domain used to resolve traffic through the private endpoint.
  - authorizerType (string) –
    
    The type of authorizer that controls how consumers access the registry’s search and MCP invoke operations.
- approvalConfiguration (dict) –
  
  Approval configuration for registry records
  - autoApprovalRules (list) –
    
    The rules that determine which registry records are automatically approved on submission. When omitted or empty, submitted records require manual review.
    - (string) –
- status (string) –
  
  Current status of the registry
- statusReason (string) –
  
  The reason for the current status. Typically populated when the status indicates a failure state.
- createdAt (datetime) –
  
  The timestamp when the registry was created
- updatedAt (datetime) –
  
  The timestamp when the registry was last updated

update_registry¶

Request Syntax

Note

Note

Note

Note

Note

Note

Response Syntax

Response Structure

Note

Note

Note

Note

Note

Note

Exceptions