AWS API Changes

2021/09/02 - Schemas - 4 updated api methods

Changes This update include the support for Schema Discoverer to discover the events sent to the bus from another account. The feature will be enabled by default when discoverer is created or updated but can also be opt-in or opt-out by specifying the value for crossAccount.

CreateDiscoverer (updated)

Link ¶
Changes (both)

{'CrossAccount': 'boolean'}

Creates a discoverer.

See also: AWS API Documentation

Request Syntax

client.create_discoverer(
    Description='string',
    SourceArn='string',
    CrossAccount=True|False,
    Tags={
        'string': 'string'
    }
)

type Description

string

param Description

A description for the discoverer.

type SourceArn

string

param SourceArn

[REQUIRED]

The ARN of the event bus.

type CrossAccount

boolean

param CrossAccount

Support discovery of schemas in events sent to the bus from another account. (default: true).

type Tags

dict

param Tags

Tags associated with the resource.

(string) --
- (string) --

rtype

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

DescribeDiscoverer (updated)

Link ¶
Changes (response)

{'CrossAccount': 'boolean'}

Describes the discoverer.

See also: AWS API Documentation

Request Syntax

client.describe_discoverer(
    DiscovererId='string'
)

type DiscovererId

string

param DiscovererId

[REQUIRED]

The ID of the discoverer.

rtype

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

ListDiscoverers (updated)

Link ¶
Changes (response)

{'Discoverers': {'CrossAccount': 'boolean'}}

List the discoverers.

See also: AWS API Documentation

Request Syntax

client.list_discoverers(
    DiscovererIdPrefix='string',
    Limit=123,
    NextToken='string',
    SourceArnPrefix='string'
)

type DiscovererIdPrefix

string

param DiscovererIdPrefix

Specifying this limits the results to only those discoverer IDs that start with the specified prefix.

type Limit

integer

param Limit

type NextToken

string

param NextToken

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.

type SourceArnPrefix

string

param SourceArnPrefix

Specifying this limits the results to only those ARNs that start with the specified prefix.

rtype

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.

UpdateDiscoverer (updated)

Link ¶
Changes (both)

{'CrossAccount': 'boolean'}

Updates the discoverer

See also: AWS API Documentation

Request Syntax

client.update_discoverer(
    Description='string',
    DiscovererId='string',
    CrossAccount=True|False
)

type Description

string

param Description

The description of the discoverer to update.

type DiscovererId

string

param DiscovererId

[REQUIRED]

The ID of the discoverer.

type CrossAccount

boolean

param CrossAccount

Support discovery of schemas in events sent to the bus from another account. (default: true)

rtype

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