AgentRegistryControl / Client / get_registry

get_registry

AgentRegistryControl.Client.get_registry(**kwargs)

Gets a registry by identifier (ARN or ID)

See also: AWS API Documentation

Request Syntax

response = client.get_registry(
    registryId='string'
)
Parameters:

registryId (string) –

[REQUIRED]

The identifier of the registry to retrieve (ARN or ID)

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 getting 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

Exceptions