Schemas ******* Client ====== class Schemas.Client A low-level client representing Schemas Amazon EventBridge Schema Registry import boto3 client = boto3.client('schemas') These are the available methods: * can_paginate * close * create_discoverer * create_registry * create_schema * delete_discoverer * delete_registry * delete_resource_policy * delete_schema * delete_schema_version * describe_code_binding * describe_discoverer * describe_registry * describe_schema * export_schema * get_code_binding_source * get_discovered_schema * get_paginator * get_resource_policy * get_waiter * list_discoverers * list_registries * list_schema_versions * list_schemas * list_tags_for_resource * put_code_binding * put_resource_policy * search_schemas * start_discoverer * stop_discoverer * tag_resource * untag_resource * update_discoverer * update_registry * update_schema Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListDiscoverers * ListRegistries * ListSchemaVersions * ListSchemas * SearchSchemas Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * CodeBindingExists Schemas / Waiter / CodeBindingExists CodeBindingExists ***************** class Schemas.Waiter.CodeBindingExists waiter = client.get_waiter('code_binding_exists') wait(**kwargs) Polls "Schemas.Client.describe_code_binding()" every 2 seconds until a successful state is reached. An error is raised after 30 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( Language='string', RegistryName='string', SchemaName='string', SchemaVersion='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **Language** (*string*) -- **[REQUIRED]** The language of the code binding. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. * **SchemaVersion** (*string*) -- Specifying this limits the results to only this schema version. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 2 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 30 Returns: None Schemas / Paginator / ListSchemaVersions ListSchemaVersions ****************** class Schemas.Paginator.ListSchemaVersions paginator = client.get_paginator('list_schema_versions') paginate(**kwargs) Creates an iterator that will paginate through responses from "Schemas.Client.list_schema_versions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( RegistryName='string', SchemaName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'SchemaVersions': [ { 'SchemaArn': 'string', 'SchemaName': 'string', 'SchemaVersion': 'string', 'Type': 'OpenApi3'|'JSONSchemaDraft4' }, ] } **Response Structure** * *(dict) --* 200 response * **SchemaVersions** *(list) --* An array of schema version summaries. * *(dict) --* * **SchemaArn** *(string) --* The ARN of the schema version. * **SchemaName** *(string) --* The name of the schema. * **SchemaVersion** *(string) --* The version number of the schema. * **Type** *(string) --* The type of schema. Schemas / Paginator / ListDiscoverers ListDiscoverers *************** class Schemas.Paginator.ListDiscoverers paginator = client.get_paginator('list_discoverers') paginate(**kwargs) Creates an iterator that will paginate through responses from "Schemas.Client.list_discoverers()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DiscovererIdPrefix='string', SourceArnPrefix='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DiscovererIdPrefix** (*string*) -- Specifying this limits the results to only those discoverer IDs that start with the specified prefix. * **SourceArnPrefix** (*string*) -- Specifying this limits the results to only those ARNs that start with the specified prefix. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Discoverers': [ { 'DiscovererArn': 'string', 'DiscovererId': 'string', 'SourceArn': 'string', 'State': 'STARTED'|'STOPPED', 'CrossAccount': True|False, 'Tags': { 'string': 'string' } }, ], } **Response Structure** * *(dict) --* 200 response * **Discoverers** *(list) --* An array of DiscovererSummary information. * *(dict) --* * **DiscovererArn** *(string) --* The ARN of the discoverer. * **DiscovererId** *(string) --* The ID of the discoverer. * **SourceArn** *(string) --* The ARN of the event bus. * **State** *(string) --* The state of the discoverer. * **CrossAccount** *(boolean) --* The Status if the discoverer will discover schemas from events sent from another account. * **Tags** *(dict) --* Tags associated with the resource. * *(string) --* * *(string) --* Schemas / Paginator / SearchSchemas SearchSchemas ************* class Schemas.Paginator.SearchSchemas paginator = client.get_paginator('search_schemas') paginate(**kwargs) Creates an iterator that will paginate through responses from "Schemas.Client.search_schemas()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Keywords='string', RegistryName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Keywords** (*string*) -- **[REQUIRED]** Specifying this limits the results to only schemas that include the provided keywords. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Schemas': [ { 'RegistryName': 'string', 'SchemaArn': 'string', 'SchemaName': 'string', 'SchemaVersions': [ { 'CreatedDate': datetime(2015, 1, 1), 'SchemaVersion': 'string', 'Type': 'OpenApi3'|'JSONSchemaDraft4' }, ] }, ] } **Response Structure** * *(dict) --* 200 response * **Schemas** *(list) --* An array of SearchSchemaSummary information. * *(dict) --* * **RegistryName** *(string) --* The name of the registry. * **SchemaArn** *(string) --* The ARN of the schema. * **SchemaName** *(string) --* The name of the schema. * **SchemaVersions** *(list) --* An array of schema version summaries. * *(dict) --* * **CreatedDate** *(datetime) --* The date the schema version was created. * **SchemaVersion** *(string) --* The version number of the schema * **Type** *(string) --* The type of schema. Schemas / Paginator / ListRegistries ListRegistries ************** class Schemas.Paginator.ListRegistries paginator = client.get_paginator('list_registries') paginate(**kwargs) Creates an iterator that will paginate through responses from "Schemas.Client.list_registries()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( RegistryNamePrefix='string', Scope='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **RegistryNamePrefix** (*string*) -- Specifying this limits the results to only those registry names that start with the specified prefix. * **Scope** (*string*) -- Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Registries': [ { 'RegistryArn': 'string', 'RegistryName': 'string', 'Tags': { 'string': 'string' } }, ] } **Response Structure** * *(dict) --* 200 response * **Registries** *(list) --* An array of registry summaries. * *(dict) --* * **RegistryArn** *(string) --* The ARN of the registry. * **RegistryName** *(string) --* The name of the registry. * **Tags** *(dict) --* Tags associated with the registry. * *(string) --* * *(string) --* Schemas / Paginator / ListSchemas ListSchemas *********** class Schemas.Paginator.ListSchemas paginator = client.get_paginator('list_schemas') paginate(**kwargs) Creates an iterator that will paginate through responses from "Schemas.Client.list_schemas()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( RegistryName='string', SchemaNamePrefix='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaNamePrefix** (*string*) -- Specifying this limits the results to only those schema names that start with the specified prefix. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max-items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Schemas': [ { 'LastModified': datetime(2015, 1, 1), 'SchemaArn': 'string', 'SchemaName': 'string', 'Tags': { 'string': 'string' }, 'VersionCount': 123 }, ] } **Response Structure** * *(dict) --* 200 response * **Schemas** *(list) --* An array of schema summaries. * *(dict) --* A summary of schema details. * **LastModified** *(datetime) --* The date and time that schema was modified. * **SchemaArn** *(string) --* The ARN of the schema. * **SchemaName** *(string) --* The name of the schema. * **Tags** *(dict) --* Tags associated with the schema. * *(string) --* * *(string) --* * **VersionCount** *(integer) --* The number of versions available for the schema. Schemas / Client / delete_discoverer delete_discoverer ***************** Schemas.Client.delete_discoverer(**kwargs) Deletes a discoverer. See also: AWS API Documentation **Request Syntax** response = client.delete_discoverer( DiscovererId='string' ) Parameters: **DiscovererId** (*string*) -- **[REQUIRED]** The ID of the discoverer. Returns: None **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / get_paginator get_paginator ************* Schemas.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. Schemas / Client / export_schema export_schema ************* Schemas.Client.export_schema(**kwargs) See also: AWS API Documentation **Request Syntax** response = client.export_schema( RegistryName='string', SchemaName='string', SchemaVersion='string', Type='string' ) Parameters: * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. * **SchemaVersion** (*string*) -- Specifying this limits the results to only this schema version. * **Type** (*string*) -- **[REQUIRED]** Return type: dict Returns: **Response Syntax** { 'Content': 'string', 'SchemaArn': 'string', 'SchemaName': 'string', 'SchemaVersion': 'string', 'Type': 'string' } **Response Structure** * *(dict) --* 200 response * **Content** *(string) --* * **SchemaArn** *(string) --* * **SchemaName** *(string) --* * **SchemaVersion** *(string) --* * **Type** *(string) --* **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" * "Schemas.Client.exceptions.TooManyRequestsException" Schemas / Client / put_code_binding put_code_binding **************** Schemas.Client.put_code_binding(**kwargs) Put code binding URI See also: AWS API Documentation **Request Syntax** response = client.put_code_binding( Language='string', RegistryName='string', SchemaName='string', SchemaVersion='string' ) Parameters: * **Language** (*string*) -- **[REQUIRED]** The language of the code binding. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. * **SchemaVersion** (*string*) -- Specifying this limits the results to only this schema version. Return type: dict Returns: **Response Syntax** { 'CreationDate': datetime(2015, 1, 1), 'LastModified': datetime(2015, 1, 1), 'SchemaVersion': 'string', 'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED' } **Response Structure** * *(dict) --* 202 response * **CreationDate** *(datetime) --* The time and date that the code binding was created. * **LastModified** *(datetime) --* The date and time that code bindings were modified. * **SchemaVersion** *(string) --* The version number of the schema. * **Status** *(string) --* The current status of code binding generation. **Exceptions** * "Schemas.Client.exceptions.GoneException" * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.TooManyRequestsException" Schemas / Client / create_registry create_registry *************** Schemas.Client.create_registry(**kwargs) Creates a registry. See also: AWS API Documentation **Request Syntax** response = client.create_registry( Description='string', RegistryName='string', Tags={ 'string': 'string' } ) Parameters: * **Description** (*string*) -- A description of the registry to be created. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **Tags** (*dict*) -- Tags to associate with the registry. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Description': 'string', 'RegistryArn': 'string', 'RegistryName': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* 201 response * **Description** *(string) --* The description of the registry. * **RegistryArn** *(string) --* The ARN of the registry. * **RegistryName** *(string) --* The name of the registry. * **Tags** *(dict) --* Tags associated with the registry. * *(string) --* * *(string) --* **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.ServiceUnavailableException" * "Schemas.Client.exceptions.ConflictException" Schemas / Client / can_paginate can_paginate ************ Schemas.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. Schemas / Client / get_code_binding_source get_code_binding_source *********************** Schemas.Client.get_code_binding_source(**kwargs) Get the code binding source URI. See also: AWS API Documentation **Request Syntax** response = client.get_code_binding_source( Language='string', RegistryName='string', SchemaName='string', SchemaVersion='string' ) Parameters: * **Language** (*string*) -- **[REQUIRED]** The language of the code binding. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. * **SchemaVersion** (*string*) -- Specifying this limits the results to only this schema version. Return type: dict Returns: **Response Syntax** { 'Body': StreamingBody() } **Response Structure** * *(dict) --* 200 response * **Body** ("StreamingBody") -- **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.TooManyRequestsException" Schemas / Client / update_registry update_registry *************** Schemas.Client.update_registry(**kwargs) Updates a registry. See also: AWS API Documentation **Request Syntax** response = client.update_registry( Description='string', RegistryName='string' ) Parameters: * **Description** (*string*) -- The description of the registry to update. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. Return type: dict Returns: **Response Syntax** { 'Description': 'string', 'RegistryArn': 'string', 'RegistryName': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* 200 response * **Description** *(string) --* The description of the registry. * **RegistryArn** *(string) --* The ARN of the registry. * **RegistryName** *(string) --* The name of the registry. * **Tags** *(dict) --* Tags associated with the registry. * *(string) --* * *(string) --* **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / list_schema_versions list_schema_versions ******************** Schemas.Client.list_schema_versions(**kwargs) Provides a list of the schema versions and related information. See also: AWS API Documentation **Request Syntax** response = client.list_schema_versions( Limit=123, NextToken='string', RegistryName='string', SchemaName='string' ) Parameters: * **Limit** (*integer*) * **NextToken** (*string*) -- The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'SchemaVersions': [ { 'SchemaArn': 'string', 'SchemaName': 'string', 'SchemaVersion': 'string', 'Type': 'OpenApi3'|'JSONSchemaDraft4' }, ] } **Response Structure** * *(dict) --* 200 response * **NextToken** *(string) --* The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts. * **SchemaVersions** *(list) --* An array of schema version summaries. * *(dict) --* * **SchemaArn** *(string) --* The ARN of the schema version. * **SchemaName** *(string) --* The name of the schema. * **SchemaVersion** *(string) --* The version number of the schema. * **Type** *(string) --* The type of schema. **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / describe_registry describe_registry ***************** Schemas.Client.describe_registry(**kwargs) Describes the registry. See also: AWS API Documentation **Request Syntax** response = client.describe_registry( RegistryName='string' ) Parameters: **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. Return type: dict Returns: **Response Syntax** { 'Description': 'string', 'RegistryArn': 'string', 'RegistryName': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* 200 response * **Description** *(string) --* The description of the registry. * **RegistryArn** *(string) --* The ARN of the registry. * **RegistryName** *(string) --* The name of the registry. * **Tags** *(dict) --* Tags associated with the registry. * *(string) --* * *(string) --* **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / update_discoverer update_discoverer ***************** Schemas.Client.update_discoverer(**kwargs) Updates the discoverer See also: AWS API Documentation **Request Syntax** response = client.update_discoverer( Description='string', DiscovererId='string', CrossAccount=True|False ) Parameters: * **Description** (*string*) -- The description of the discoverer to update. * **DiscovererId** (*string*) -- **[REQUIRED]** The ID of the discoverer. * **CrossAccount** (*boolean*) -- Support discovery of schemas in events sent to the bus from another account. (default: true) Return type: dict Returns: **Response Syntax** { 'Description': 'string', 'DiscovererArn': 'string', 'DiscovererId': 'string', 'SourceArn': 'string', 'State': 'STARTED'|'STOPPED', 'CrossAccount': True|False, 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* 200 response * **Description** *(string) --* The description of the discoverer. * **DiscovererArn** *(string) --* The ARN of the discoverer. * **DiscovererId** *(string) --* The ID of the discoverer. * **SourceArn** *(string) --* The ARN of the event bus. * **State** *(string) --* The state of the discoverer. * **CrossAccount** *(boolean) --* The Status if the discoverer will discover schemas from events sent from another account. * **Tags** *(dict) --* Tags associated with the resource. * *(string) --* * *(string) --* **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / list_tags_for_resource list_tags_for_resource ********************** Schemas.Client.list_tags_for_resource(**kwargs) Get tags for resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* 200 response * **Tags** *(dict) --* Key-value pairs associated with a resource. * *(string) --* * *(string) --* **Exceptions** * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" Schemas / Client / untag_resource untag_resource ************** Schemas.Client.untag_resource(**kwargs) Removes tags from a resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource. * **TagKeys** (*list*) -- **[REQUIRED]** Keys of key-value pairs. * *(string) --* Returns: None **Exceptions** * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" Schemas / Client / get_waiter get_waiter ********** Schemas.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" Schemas / Client / list_discoverers list_discoverers **************** Schemas.Client.list_discoverers(**kwargs) List the discoverers. See also: AWS API Documentation **Request Syntax** response = client.list_discoverers( DiscovererIdPrefix='string', Limit=123, NextToken='string', SourceArnPrefix='string' ) Parameters: * **DiscovererIdPrefix** (*string*) -- Specifying this limits the results to only those discoverer IDs that start with the specified prefix. * **Limit** (*integer*) * **NextToken** (*string*) -- The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts. * **SourceArnPrefix** (*string*) -- Specifying this limits the results to only those ARNs that start with the specified prefix. Return type: dict Returns: **Response Syntax** { 'Discoverers': [ { 'DiscovererArn': 'string', 'DiscovererId': 'string', 'SourceArn': 'string', 'State': 'STARTED'|'STOPPED', 'CrossAccount': True|False, 'Tags': { 'string': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* 200 response * **Discoverers** *(list) --* An array of DiscovererSummary information. * *(dict) --* * **DiscovererArn** *(string) --* The ARN of the discoverer. * **DiscovererId** *(string) --* The ID of the discoverer. * **SourceArn** *(string) --* The ARN of the event bus. * **State** *(string) --* The state of the discoverer. * **CrossAccount** *(boolean) --* The Status if the discoverer will discover schemas from events sent from another account. * **Tags** *(dict) --* Tags associated with the resource. * *(string) --* * *(string) --* * **NextToken** *(string) --* The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts. **Exceptions** * "Schemas.Client.exceptions.ServiceUnavailableException" * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" Schemas / Client / describe_discoverer describe_discoverer ******************* Schemas.Client.describe_discoverer(**kwargs) Describes the discoverer. See also: AWS API Documentation **Request Syntax** response = client.describe_discoverer( DiscovererId='string' ) Parameters: **DiscovererId** (*string*) -- **[REQUIRED]** The ID of the discoverer. Return type: dict Returns: **Response Syntax** { 'Description': 'string', 'DiscovererArn': 'string', 'DiscovererId': 'string', 'SourceArn': 'string', 'State': 'STARTED'|'STOPPED', 'CrossAccount': True|False, 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* 200 response * **Description** *(string) --* The description of the discoverer. * **DiscovererArn** *(string) --* The ARN of the discoverer. * **DiscovererId** *(string) --* The ID of the discoverer. * **SourceArn** *(string) --* The ARN of the event bus. * **State** *(string) --* The state of the discoverer. * **CrossAccount** *(boolean) --* The Status if the discoverer will discover schemas from events sent from another account. * **Tags** *(dict) --* Tags associated with the resource. * *(string) --* * *(string) --* **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / get_discovered_schema get_discovered_schema ********************* Schemas.Client.get_discovered_schema(**kwargs) Get the discovered schema that was generated based on sampled events. See also: AWS API Documentation **Request Syntax** response = client.get_discovered_schema( Events=[ 'string', ], Type='OpenApi3'|'JSONSchemaDraft4' ) Parameters: * **Events** (*list*) -- **[REQUIRED]** An array of strings where each string is a JSON event. These are the events that were used to generate the schema. The array includes a single type of event and has a maximum size of 10 events. * *(string) --* * **Type** (*string*) -- **[REQUIRED]** The type of event. Return type: dict Returns: **Response Syntax** { 'Content': 'string' } **Response Structure** * *(dict) --* 200 response * **Content** *(string) --* The source of the schema definition. **Exceptions** * "Schemas.Client.exceptions.ServiceUnavailableException" * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" Schemas / Client / delete_registry delete_registry *************** Schemas.Client.delete_registry(**kwargs) Deletes a Registry. See also: AWS API Documentation **Request Syntax** response = client.delete_registry( RegistryName='string' ) Parameters: **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. Returns: None **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / describe_code_binding describe_code_binding ********************* Schemas.Client.describe_code_binding(**kwargs) Describe the code binding URI. See also: AWS API Documentation **Request Syntax** response = client.describe_code_binding( Language='string', RegistryName='string', SchemaName='string', SchemaVersion='string' ) Parameters: * **Language** (*string*) -- **[REQUIRED]** The language of the code binding. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. * **SchemaVersion** (*string*) -- Specifying this limits the results to only this schema version. Return type: dict Returns: **Response Syntax** { 'CreationDate': datetime(2015, 1, 1), 'LastModified': datetime(2015, 1, 1), 'SchemaVersion': 'string', 'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED' } **Response Structure** * *(dict) --* 200 response * **CreationDate** *(datetime) --* The time and date that the code binding was created. * **LastModified** *(datetime) --* The date and time that code bindings were modified. * **SchemaVersion** *(string) --* The version number of the schema. * **Status** *(string) --* The current status of code binding generation. **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.TooManyRequestsException" Schemas / Client / create_schema create_schema ************* Schemas.Client.create_schema(**kwargs) Creates a schema definition. Note: Inactive schemas will be deleted after two years. See also: AWS API Documentation **Request Syntax** response = client.create_schema( Content='string', Description='string', RegistryName='string', SchemaName='string', Tags={ 'string': 'string' }, Type='OpenApi3'|'JSONSchemaDraft4' ) Parameters: * **Content** (*string*) -- **[REQUIRED]** The source of the schema definition. * **Description** (*string*) -- A description of the schema. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. * **Tags** (*dict*) -- Tags associated with the schema. * *(string) --* * *(string) --* * **Type** (*string*) -- **[REQUIRED]** The type of schema. Return type: dict Returns: **Response Syntax** { 'Description': 'string', 'LastModified': datetime(2015, 1, 1), 'SchemaArn': 'string', 'SchemaName': 'string', 'SchemaVersion': 'string', 'Tags': { 'string': 'string' }, 'Type': 'string', 'VersionCreatedDate': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* 201 response * **Description** *(string) --* The description of the schema. * **LastModified** *(datetime) --* The date and time that schema was modified. * **SchemaArn** *(string) --* The ARN of the schema. * **SchemaName** *(string) --* The name of the schema. * **SchemaVersion** *(string) --* The version number of the schema * **Tags** *(dict) --* Key-value pairs associated with a resource. * *(string) --* * *(string) --* * **Type** *(string) --* The type of the schema. * **VersionCreatedDate** *(datetime) --* The date the schema version was created. **Exceptions** * "Schemas.Client.exceptions.ServiceUnavailableException" * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" Schemas / Client / list_registries list_registries *************** Schemas.Client.list_registries(**kwargs) List the registries. See also: AWS API Documentation **Request Syntax** response = client.list_registries( Limit=123, NextToken='string', RegistryNamePrefix='string', Scope='string' ) Parameters: * **Limit** (*integer*) * **NextToken** (*string*) -- The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts. * **RegistryNamePrefix** (*string*) -- Specifying this limits the results to only those registry names that start with the specified prefix. * **Scope** (*string*) -- Can be set to Local or AWS to limit responses to your custom registries, or the ones provided by AWS. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Registries': [ { 'RegistryArn': 'string', 'RegistryName': 'string', 'Tags': { 'string': 'string' } }, ] } **Response Structure** * *(dict) --* 200 response * **NextToken** *(string) --* The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts. * **Registries** *(list) --* An array of registry summaries. * *(dict) --* * **RegistryArn** *(string) --* The ARN of the registry. * **RegistryName** *(string) --* The name of the registry. * **Tags** *(dict) --* Tags associated with the registry. * *(string) --* * *(string) --* **Exceptions** * "Schemas.Client.exceptions.ServiceUnavailableException" * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" Schemas / Client / delete_schema delete_schema ************* Schemas.Client.delete_schema(**kwargs) Delete a schema definition. See also: AWS API Documentation **Request Syntax** response = client.delete_schema( RegistryName='string', SchemaName='string' ) Parameters: * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. Returns: None **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / update_schema update_schema ************* Schemas.Client.update_schema(**kwargs) Updates the schema definition Note: Inactive schemas will be deleted after two years. See also: AWS API Documentation **Request Syntax** response = client.update_schema( ClientTokenId='string', Content='string', Description='string', RegistryName='string', SchemaName='string', Type='OpenApi3'|'JSONSchemaDraft4' ) Parameters: * **ClientTokenId** (*string*) -- The ID of the client token. This field is autopopulated if not provided. * **Content** (*string*) -- The source of the schema definition. * **Description** (*string*) -- The description of the schema. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. * **Type** (*string*) -- The schema type for the events schema. Return type: dict Returns: **Response Syntax** { 'Description': 'string', 'LastModified': datetime(2015, 1, 1), 'SchemaArn': 'string', 'SchemaName': 'string', 'SchemaVersion': 'string', 'Tags': { 'string': 'string' }, 'Type': 'string', 'VersionCreatedDate': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* 200 response * **Description** *(string) --* The description of the schema. * **LastModified** *(datetime) --* The date and time that schema was modified. * **SchemaArn** *(string) --* The ARN of the schema. * **SchemaName** *(string) --* The name of the schema. * **SchemaVersion** *(string) --* The version number of the schema * **Tags** *(dict) --* Key-value pairs associated with a resource. * *(string) --* * *(string) --* * **Type** *(string) --* The type of the schema. * **VersionCreatedDate** *(datetime) --* The date the schema version was created. **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / list_schemas list_schemas ************ Schemas.Client.list_schemas(**kwargs) List the schemas. See also: AWS API Documentation **Request Syntax** response = client.list_schemas( Limit=123, NextToken='string', RegistryName='string', SchemaNamePrefix='string' ) Parameters: * **Limit** (*integer*) * **NextToken** (*string*) -- The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaNamePrefix** (*string*) -- Specifying this limits the results to only those schema names that start with the specified prefix. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Schemas': [ { 'LastModified': datetime(2015, 1, 1), 'SchemaArn': 'string', 'SchemaName': 'string', 'Tags': { 'string': 'string' }, 'VersionCount': 123 }, ] } **Response Structure** * *(dict) --* 200 response * **NextToken** *(string) --* The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts. * **Schemas** *(list) --* An array of schema summaries. * *(dict) --* A summary of schema details. * **LastModified** *(datetime) --* The date and time that schema was modified. * **SchemaArn** *(string) --* The ARN of the schema. * **SchemaName** *(string) --* The name of the schema. * **Tags** *(dict) --* Tags associated with the schema. * *(string) --* * *(string) --* * **VersionCount** *(integer) --* The number of versions available for the schema. **Exceptions** * "Schemas.Client.exceptions.ServiceUnavailableException" * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" Schemas / Client / delete_schema_version delete_schema_version ********************* Schemas.Client.delete_schema_version(**kwargs) Delete the schema version definition See also: AWS API Documentation **Request Syntax** response = client.delete_schema_version( RegistryName='string', SchemaName='string', SchemaVersion='string' ) Parameters: * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. * **SchemaVersion** (*string*) -- **[REQUIRED]** The version number of the schema Returns: None **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / close close ***** Schemas.Client.close() Closes underlying endpoint connections. Schemas / Client / put_resource_policy put_resource_policy ******************* Schemas.Client.put_resource_policy(**kwargs) The name of the policy. See also: AWS API Documentation **Request Syntax** response = client.put_resource_policy( Policy='string', RegistryName='string', RevisionId='string' ) Parameters: * **Policy** (*string*) -- **[REQUIRED]** The resource-based policy. * **RegistryName** (*string*) -- The name of the registry. * **RevisionId** (*string*) -- The revision ID of the policy. Return type: dict Returns: **Response Syntax** { 'Policy': 'string', 'RevisionId': 'string' } **Response Structure** * *(dict) --* 200 response * **Policy** *(string) --* The resource-based policy. * **RevisionId** *(string) --* The revision ID of the policy. **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.PreconditionFailedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / get_resource_policy get_resource_policy ******************* Schemas.Client.get_resource_policy(**kwargs) Retrieves the resource-based policy attached to a given registry. See also: AWS API Documentation **Request Syntax** response = client.get_resource_policy( RegistryName='string' ) Parameters: **RegistryName** (*string*) -- The name of the registry. Return type: dict Returns: **Response Syntax** { 'Policy': 'string', 'RevisionId': 'string' } **Response Structure** * *(dict) --* Get Resource-Based Policy Response * **Policy** *(string) --* The resource-based policy. * **RevisionId** *(string) --* The revision ID. **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / start_discoverer start_discoverer **************** Schemas.Client.start_discoverer(**kwargs) Starts the discoverer See also: AWS API Documentation **Request Syntax** response = client.start_discoverer( DiscovererId='string' ) Parameters: **DiscovererId** (*string*) -- **[REQUIRED]** The ID of the discoverer. Return type: dict Returns: **Response Syntax** { 'DiscovererId': 'string', 'State': 'STARTED'|'STOPPED' } **Response Structure** * *(dict) --* 200 response * **DiscovererId** *(string) --* The ID of the discoverer. * **State** *(string) --* The state of the discoverer. **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / search_schemas search_schemas ************** Schemas.Client.search_schemas(**kwargs) Search the schemas See also: AWS API Documentation **Request Syntax** response = client.search_schemas( Keywords='string', Limit=123, NextToken='string', RegistryName='string' ) Parameters: * **Keywords** (*string*) -- **[REQUIRED]** Specifying this limits the results to only schemas that include the provided keywords. * **Limit** (*integer*) * **NextToken** (*string*) -- The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts. * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Schemas': [ { 'RegistryName': 'string', 'SchemaArn': 'string', 'SchemaName': 'string', 'SchemaVersions': [ { 'CreatedDate': datetime(2015, 1, 1), 'SchemaVersion': 'string', 'Type': 'OpenApi3'|'JSONSchemaDraft4' }, ] }, ] } **Response Structure** * *(dict) --* 200 response * **NextToken** *(string) --* The token that specifies the next page of results to return. To request the first page, leave NextToken empty. The token will expire in 24 hours, and cannot be shared with other accounts. * **Schemas** *(list) --* An array of SearchSchemaSummary information. * *(dict) --* * **RegistryName** *(string) --* The name of the registry. * **SchemaArn** *(string) --* The ARN of the schema. * **SchemaName** *(string) --* The name of the schema. * **SchemaVersions** *(list) --* An array of schema version summaries. * *(dict) --* * **CreatedDate** *(datetime) --* The date the schema version was created. * **SchemaVersion** *(string) --* The version number of the schema * **Type** *(string) --* The type of schema. **Exceptions** * "Schemas.Client.exceptions.ServiceUnavailableException" * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" Schemas / Client / describe_schema describe_schema *************** Schemas.Client.describe_schema(**kwargs) Retrieve the schema definition. See also: AWS API Documentation **Request Syntax** response = client.describe_schema( RegistryName='string', SchemaName='string', SchemaVersion='string' ) Parameters: * **RegistryName** (*string*) -- **[REQUIRED]** The name of the registry. * **SchemaName** (*string*) -- **[REQUIRED]** The name of the schema. * **SchemaVersion** (*string*) -- Specifying this limits the results to only this schema version. Return type: dict Returns: **Response Syntax** { 'Content': 'string', 'Description': 'string', 'LastModified': datetime(2015, 1, 1), 'SchemaArn': 'string', 'SchemaName': 'string', 'SchemaVersion': 'string', 'Tags': { 'string': 'string' }, 'Type': 'string', 'VersionCreatedDate': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* 200 response * **Content** *(string) --* The source of the schema definition. * **Description** *(string) --* The description of the schema. * **LastModified** *(datetime) --* The date and time that schema was modified. * **SchemaArn** *(string) --* The ARN of the schema. * **SchemaName** *(string) --* The name of the schema. * **SchemaVersion** *(string) --* The version number of the schema * **Tags** *(dict) --* Tags associated with the resource. * *(string) --* * *(string) --* * **Type** *(string) --* The type of the schema. * **VersionCreatedDate** *(datetime) --* The date the schema version was created. **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / tag_resource tag_resource ************ Schemas.Client.tag_resource(**kwargs) Add tags to a resource. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the resource. * **Tags** (*dict*) -- **[REQUIRED]** Tags associated with the resource. * *(string) --* * *(string) --* Returns: None **Exceptions** * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" Schemas / Client / delete_resource_policy delete_resource_policy ********************** Schemas.Client.delete_resource_policy(**kwargs) Delete the resource-based policy attached to the specified registry. See also: AWS API Documentation **Request Syntax** response = client.delete_resource_policy( RegistryName='string' ) Parameters: **RegistryName** (*string*) -- The name of the registry. Returns: None **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / stop_discoverer stop_discoverer *************** Schemas.Client.stop_discoverer(**kwargs) Stops the discoverer See also: AWS API Documentation **Request Syntax** response = client.stop_discoverer( DiscovererId='string' ) Parameters: **DiscovererId** (*string*) -- **[REQUIRED]** The ID of the discoverer. Return type: dict Returns: **Response Syntax** { 'DiscovererId': 'string', 'State': 'STARTED'|'STOPPED' } **Response Structure** * *(dict) --* 200 response * **DiscovererId** *(string) --* The ID of the discoverer. * **State** *(string) --* The state of the discoverer. **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.NotFoundException" * "Schemas.Client.exceptions.ServiceUnavailableException" Schemas / Client / create_discoverer create_discoverer ***************** Schemas.Client.create_discoverer(**kwargs) Creates a discoverer. See also: AWS API Documentation **Request Syntax** response = client.create_discoverer( Description='string', SourceArn='string', CrossAccount=True|False, Tags={ 'string': 'string' } ) Parameters: * **Description** (*string*) -- A description for the discoverer. * **SourceArn** (*string*) -- **[REQUIRED]** The ARN of the event bus. * **CrossAccount** (*boolean*) -- Support discovery of schemas in events sent to the bus from another account. (default: true). * **Tags** (*dict*) -- Tags associated with the resource. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Description': 'string', 'DiscovererArn': 'string', 'DiscovererId': 'string', 'SourceArn': 'string', 'State': 'STARTED'|'STOPPED', 'CrossAccount': True|False, 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* 201 response * **Description** *(string) --* The description of the discoverer. * **DiscovererArn** *(string) --* The ARN of the discoverer. * **DiscovererId** *(string) --* The ID of the discoverer. * **SourceArn** *(string) --* The ARN of the event bus. * **State** *(string) --* The state of the discoverer. * **CrossAccount** *(boolean) --* The Status if the discoverer will discover schemas from events sent from another account. * **Tags** *(dict) --* Tags associated with the resource. * *(string) --* * *(string) --* **Exceptions** * "Schemas.Client.exceptions.BadRequestException" * "Schemas.Client.exceptions.InternalServerErrorException" * "Schemas.Client.exceptions.UnauthorizedException" * "Schemas.Client.exceptions.ForbiddenException" * "Schemas.Client.exceptions.ServiceUnavailableException" * "Schemas.Client.exceptions.ConflictException"