AWS API Changes

2025/03/20 - AWS Amplify - 5 updated api methods

Changes Added appId field to Webhook responses

CreateWebhook (updated)

Link ¶
Changes (response)

{'webhook': {'appId': 'string'}}

Creates a new webhook on an Amplify app.

See also: AWS API Documentation

Request Syntax

client.create_webhook(
    appId='string',
    branchName='string',
    description='string'
)

type appId:

string

param appId:

[REQUIRED]

The unique ID for an Amplify app.

type branchName:

string

param branchName:

[REQUIRED]

The name for a branch that is part of an Amplify app.

type description:

string

param description:

The description for a webhook.

rtype:

dict

returns:

Response Syntax

{
    'webhook': {
        'webhookArn': 'string',
        'webhookId': 'string',
        'webhookUrl': 'string',
        'appId': 'string',
        'branchName': 'string',
        'description': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --

The result structure for the create webhook request.
- webhook (dict) --
  
  Describes a webhook that connects repository events to an Amplify app.
  - webhookArn (string) --
    
    The Amazon Resource Name (ARN) for the webhook.
  - webhookId (string) --
    
    The ID of the webhook.
  - webhookUrl (string) --
    
    The URL of the webhook.
  - appId (string) --
    
    The unique ID of an Amplify app.
  - branchName (string) --
    
    The name for a branch that is part of an Amplify app.
  - description (string) --
    
    The description for a webhook.
  - createTime (datetime) --
    
    A timestamp of when Amplify created the webhook in your Git repository.
  - updateTime (datetime) --
    
    A timestamp of when Amplify updated the webhook in your Git repository.

DeleteWebhook (updated)

Link ¶
Changes (response)

{'webhook': {'appId': 'string'}}

Deletes a webhook.

See also: AWS API Documentation

Request Syntax

client.delete_webhook(
    webhookId='string'
)

type webhookId:

string

param webhookId:

[REQUIRED]

The unique ID for a webhook.

rtype:

dict

returns:

Response Syntax

{
    'webhook': {
        'webhookArn': 'string',
        'webhookId': 'string',
        'webhookUrl': 'string',
        'appId': 'string',
        'branchName': 'string',
        'description': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --

The result structure for the delete webhook request.
- webhook (dict) --
  
  Describes a webhook that connects repository events to an Amplify app.
  - webhookArn (string) --
    
    The Amazon Resource Name (ARN) for the webhook.
  - webhookId (string) --
    
    The ID of the webhook.
  - webhookUrl (string) --
    
    The URL of the webhook.
  - appId (string) --
    
    The unique ID of an Amplify app.
  - branchName (string) --
    
    The name for a branch that is part of an Amplify app.
  - description (string) --
    
    The description for a webhook.
  - createTime (datetime) --
    
    A timestamp of when Amplify created the webhook in your Git repository.
  - updateTime (datetime) --
    
    A timestamp of when Amplify updated the webhook in your Git repository.

GetWebhook (updated)

Link ¶
Changes (response)

{'webhook': {'appId': 'string'}}

Returns the webhook information that corresponds to a specified webhook ID.

See also: AWS API Documentation

Request Syntax

client.get_webhook(
    webhookId='string'
)

type webhookId:

string

param webhookId:

[REQUIRED]

The unique ID for a webhook.

rtype:

dict

returns:

Response Syntax

{
    'webhook': {
        'webhookArn': 'string',
        'webhookId': 'string',
        'webhookUrl': 'string',
        'appId': 'string',
        'branchName': 'string',
        'description': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --

The result structure for the get webhook request.
- webhook (dict) --
  
  Describes the structure of a webhook.
  - webhookArn (string) --
    
    The Amazon Resource Name (ARN) for the webhook.
  - webhookId (string) --
    
    The ID of the webhook.
  - webhookUrl (string) --
    
    The URL of the webhook.
  - appId (string) --
    
    The unique ID of an Amplify app.
  - branchName (string) --
    
    The name for a branch that is part of an Amplify app.
  - description (string) --
    
    The description for a webhook.
  - createTime (datetime) --
    
    A timestamp of when Amplify created the webhook in your Git repository.
  - updateTime (datetime) --
    
    A timestamp of when Amplify updated the webhook in your Git repository.

ListWebhooks (updated)

Link ¶
Changes (response)

{'webhooks': {'appId': 'string'}}

Returns a list of webhooks for an Amplify app.

See also: AWS API Documentation

Request Syntax

client.list_webhooks(
    appId='string',
    nextToken='string',
    maxResults=123
)

type appId:

string

param appId:

[REQUIRED]

The unique ID for an Amplify app.

type nextToken:

string

param nextToken:

A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks.

type maxResults:

integer

param maxResults:

The maximum number of records to list in a single response.

rtype:

dict

returns:

Response Syntax

{
    'webhooks': [
        {
            'webhookArn': 'string',
            'webhookId': 'string',
            'webhookUrl': 'string',
            'appId': 'string',
            'branchName': 'string',
            'description': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --

The result structure for the list webhooks request.
- webhooks (list) --
  
  A list of webhooks.
  - (dict) --
    
    Describes a webhook that connects repository events to an Amplify app.
    - webhookArn (string) --
      
      The Amazon Resource Name (ARN) for the webhook.
    - webhookId (string) --
      
      The ID of the webhook.
    - webhookUrl (string) --
      
      The URL of the webhook.
    - appId (string) --
      
      The unique ID of an Amplify app.
    - branchName (string) --
      
      The name for a branch that is part of an Amplify app.
    - description (string) --
      
      The description for a webhook.
    - createTime (datetime) --
      
      A timestamp of when Amplify created the webhook in your Git repository.
    - updateTime (datetime) --
      
      A timestamp of when Amplify updated the webhook in your Git repository.
- nextToken (string) --
  
  A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.

UpdateWebhook (updated)

Link ¶
Changes (response)

{'webhook': {'appId': 'string'}}

Updates a webhook.

See also: AWS API Documentation

Request Syntax

client.update_webhook(
    webhookId='string',
    branchName='string',
    description='string'
)

type webhookId:

string

param webhookId:

[REQUIRED]

The unique ID for a webhook.

type branchName:

string

param branchName:

The name for a branch that is part of an Amplify app.

type description:

string

param description:

The description for a webhook.

rtype:

dict

returns:

Response Syntax

{
    'webhook': {
        'webhookArn': 'string',
        'webhookId': 'string',
        'webhookUrl': 'string',
        'appId': 'string',
        'branchName': 'string',
        'description': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --

The result structure for the update webhook request.
- webhook (dict) --
  
  Describes a webhook that connects repository events to an Amplify app.
  - webhookArn (string) --
    
    The Amazon Resource Name (ARN) for the webhook.
  - webhookId (string) --
    
    The ID of the webhook.
  - webhookUrl (string) --
    
    The URL of the webhook.
  - appId (string) --
    
    The unique ID of an Amplify app.
  - branchName (string) --
    
    The name for a branch that is part of an Amplify app.
  - description (string) --
    
    The description for a webhook.
  - createTime (datetime) --
    
    A timestamp of when Amplify created the webhook in your Git repository.
  - updateTime (datetime) --
    
    A timestamp of when Amplify updated the webhook in your Git repository.