Trebuchet

Table of Contents

Client

class Trebuchet.Client

A low-level client representing AWS Trebuchet:

import boto3

client = boto3.client('trebuchet')

These are the available methods:

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.
create_feature_release(**kwargs)

Request Syntax

response = client.create_feature_release(
    featureName='string',
    serviceName='string',
    description='string',
    serviceOwner='string',
    sdkOwner='string',
    serviceReleaseDate=datetime(2015, 1, 1),
    sdkReleaseDate=datetime(2015, 1, 1),
    type='CUSTOM_SDK_WORK'|'NEW_SERVICE'|'NEW_FEATURE'|'DOC_UPDATE'
)
Parameters
  • featureName (string) --
  • serviceName (string) --
  • description (string) --
  • serviceOwner (string) --
  • sdkOwner (string) --
  • serviceReleaseDate (datetime) --
  • sdkReleaseDate (datetime) --
  • type (string) --
Return type

dict

Returns

Response Syntax

{
    'featureArn': 'string',
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • featureArn (string) --
    • creationTime (datetime) --

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_artifacts(**kwargs)

Request Syntax

response = client.get_artifacts(
    featureArn='string'
)
Parameters
featureArn (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'artifacts': [
        {
            'name': 'string',
            'type': 'string',
            'description': 'string',
            'data': b'bytes',
            'processState': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • artifacts (list) --
      • (dict) --
        • name (string) --
        • type (string) --
        • description (string) --
        • data (bytes) --
        • processState (string) --
get_assigned_activities(**kwargs)

Request Syntax

response = client.get_assigned_activities(
    user='string'
)
Parameters
user (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'activities': [
        {
            'activityArn': 'string',
            'parent': 'string',
            'featureArn': 'string',
            'description': 'string',
            'status': 'string',
            'statusReason': 'string',
            'assignee': 'string',
            'approver': 'string',
            'leadtime': {
                'unit': 'string',
                'value': 123
            },
            'details': {
                'relatedItems': [
                    {
                        'type': 'string',
                        'value': b'bytes'
                    },
                ],
                'timeline': {
                    'start': datetime(2015, 1, 1),
                    'estimatedFinish': datetime(2015, 1, 1),
                    'actualFinish': datetime(2015, 1, 1)
                }
            }
        },
    ],
    'featureSummaries': {
        'string': {
            'name': 'string',
            'service': 'string',
            'type': 'string',
            'description': 'string',
            'sdkOwner': 'string',
            'serviceOwner': 'string',
            'serviceReleaseDate': datetime(2015, 1, 1),
            'sdkReleaseDate': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --
    • activities (list) --
      • (dict) --
        • activityArn (string) --
        • parent (string) --
        • featureArn (string) --
        • description (string) --
        • status (string) --
        • statusReason (string) --
        • assignee (string) --
        • approver (string) --
        • leadtime (dict) --
          • unit (string) --
          • value (integer) --
        • details (dict) --
          • relatedItems (list) --
            • (dict) --
              • type (string) --
              • value (bytes) --
          • timeline (dict) --
            • start (datetime) --
            • estimatedFinish (datetime) --
            • actualFinish (datetime) --
    • featureSummaries (dict) --
      • (string) --
        • (dict) --
          • name (string) --
          • service (string) --
          • type (string) --
          • description (string) --
          • sdkOwner (string) --
          • serviceOwner (string) --
          • serviceReleaseDate (datetime) --
          • sdkReleaseDate (datetime) --
get_feature_release(**kwargs)

Request Syntax

response = client.get_feature_release(
    featureArn='string'
)
Parameters
featureArn (string) -- [REQUIRED]
Return type
dict
Returns
Response Syntax
{
    'feature': {
        'featureArn': 'string',
        'name': 'string',
        'service': 'string',
        'type': 'string',
        'description': 'string',
        'serviceOwner': 'string',
        'sdkOwner': 'string',
        'serviceReleaseDate': datetime(2015, 1, 1),
        'sdkReleaseDate': datetime(2015, 1, 1),
        'creationTime': datetime(2015, 1, 1),
        'lastUpdatedTime': datetime(2015, 1, 1),
        'activities': [
            {
                'activityArn': 'string',
                'parent': 'string',
                'featureArn': 'string',
                'description': 'string',
                'status': 'string',
                'statusReason': 'string',
                'assignee': 'string',
                'approver': 'string',
                'leadtime': {
                    'unit': 'string',
                    'value': 123
                },
                'details': {
                    'relatedItems': [
                        {
                            'type': 'string',
                            'value': b'bytes'
                        },
                    ],
                    'timeline': {
                        'start': datetime(2015, 1, 1),
                        'estimatedFinish': datetime(2015, 1, 1),
                        'actualFinish': datetime(2015, 1, 1)
                    }
                }
            },
        ]
    }
}

Response Structure

  • (dict) --
    • feature (dict) --
      • featureArn (string) --
      • name (string) --
      • service (string) --
      • type (string) --
      • description (string) --
      • serviceOwner (string) --
      • sdkOwner (string) --
      • serviceReleaseDate (datetime) --
      • sdkReleaseDate (datetime) --
      • creationTime (datetime) --
      • lastUpdatedTime (datetime) --
      • activities (list) --
        • (dict) --
          • activityArn (string) --
          • parent (string) --
          • featureArn (string) --
          • description (string) --
          • status (string) --
          • statusReason (string) --
          • assignee (string) --
          • approver (string) --
          • leadtime (dict) --
            • unit (string) --
            • value (integer) --
          • details (dict) --
            • relatedItems (list) --
              • (dict) --
                • type (string) --
                • value (bytes) --
            • timeline (dict) --
              • start (datetime) --
              • estimatedFinish (datetime) --
              • actualFinish (datetime) --
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
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)
list_feature_releases(**kwargs)

Request Syntax

response = client.list_feature_releases(
    filter={
        'service': 'string',
        'serviceOwner': 'string',
        'sdkOwner': 'string',
        'serviceReleaseDateRange': {
            'From': datetime(2015, 1, 1),
            'To': datetime(2015, 1, 1)
        },
        'sdkReleaseDateRange': {
            'From': datetime(2015, 1, 1),
            'To': datetime(2015, 1, 1)
        }
    }
)
Parameters
filter (dict) --
  • service (string) --
  • serviceOwner (string) --
  • sdkOwner (string) --
  • serviceReleaseDateRange (dict) --
    • From (datetime) --
    • To (datetime) --
  • sdkReleaseDateRange (dict) --
    • From (datetime) --
    • To (datetime) --
Return type
dict
Returns
Response Syntax
{
    'featureSummaries': {
        'string': {
            'name': 'string',
            'service': 'string',
            'type': 'string',
            'description': 'string',
            'sdkOwner': 'string',
            'serviceOwner': 'string',
            'serviceReleaseDate': datetime(2015, 1, 1),
            'sdkReleaseDate': datetime(2015, 1, 1)
        }
    }
}

Response Structure

  • (dict) --
    • featureSummaries (dict) --
      • (string) --
        • (dict) --
          • name (string) --
          • service (string) --
          • type (string) --
          • description (string) --
          • sdkOwner (string) --
          • serviceOwner (string) --
          • serviceReleaseDate (datetime) --
          • sdkReleaseDate (datetime) --
put_artifacts(**kwargs)

Request Syntax

response = client.put_artifacts(
    featureArn='string',
    activityArn='string',
    artifacts=[
        {
            'name': 'string',
            'type': 'string',
            'description': 'string',
            'data': b'bytes',
            'processState': 'string'
        },
    ]
)
Parameters
  • featureArn (string) -- [REQUIRED]
  • activityArn (string) --
  • artifacts (list) --

    [REQUIRED]

    • (dict) --
      • name (string) -- [REQUIRED]
      • type (string) --
      • description (string) --
      • data (bytes) --
      • processState (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_activity(**kwargs)

Request Syntax

response = client.update_activity(
    activityArn='string',
    status='string',
    statusReason='string',
    description='string',
    assignee='string',
    approver='string'
)
Parameters
  • activityArn (string) -- [REQUIRED]
  • status (string) --
  • statusReason (string) --
  • description (string) --
  • assignee (string) --
  • approver (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_feature(**kwargs)

Request Syntax

response = client.update_feature(
    featureArn='string',
    featureName='string',
    serviceName='string',
    description='string',
    serviceOwner='string',
    sdkOwner='string',
    serviceReleaseDate=datetime(2015, 1, 1),
    sdkReleaseDate=datetime(2015, 1, 1)
)
Parameters
  • featureArn (string) -- [REQUIRED]
  • featureName (string) --
  • serviceName (string) --
  • description (string) --
  • serviceOwner (string) --
  • sdkOwner (string) --
  • serviceReleaseDate (datetime) --
  • sdkReleaseDate (datetime) --
Return type

dict

Returns

Response Syntax

{
    'feature': {
        'featureArn': 'string',
        'name': 'string',
        'service': 'string',
        'type': 'string',
        'description': 'string',
        'serviceOwner': 'string',
        'sdkOwner': 'string',
        'serviceReleaseDate': datetime(2015, 1, 1),
        'sdkReleaseDate': datetime(2015, 1, 1),
        'creationTime': datetime(2015, 1, 1),
        'lastUpdatedTime': datetime(2015, 1, 1),
        'activities': [
            {
                'activityArn': 'string',
                'parent': 'string',
                'featureArn': 'string',
                'description': 'string',
                'status': 'string',
                'statusReason': 'string',
                'assignee': 'string',
                'approver': 'string',
                'leadtime': {
                    'unit': 'string',
                    'value': 123
                },
                'details': {
                    'relatedItems': [
                        {
                            'type': 'string',
                            'value': b'bytes'
                        },
                    ],
                    'timeline': {
                        'start': datetime(2015, 1, 1),
                        'estimatedFinish': datetime(2015, 1, 1),
                        'actualFinish': datetime(2015, 1, 1)
                    }
                }
            },
        ]
    }
}

Response Structure

  • (dict) --
    • feature (dict) --
      • featureArn (string) --
      • name (string) --
      • service (string) --
      • type (string) --
      • description (string) --
      • serviceOwner (string) --
      • sdkOwner (string) --
      • serviceReleaseDate (datetime) --
      • sdkReleaseDate (datetime) --
      • creationTime (datetime) --
      • lastUpdatedTime (datetime) --
      • activities (list) --
        • (dict) --
          • activityArn (string) --
          • parent (string) --
          • featureArn (string) --
          • description (string) --
          • status (string) --
          • statusReason (string) --
          • assignee (string) --
          • approver (string) --
          • leadtime (dict) --
            • unit (string) --
            • value (integer) --
          • details (dict) --
            • relatedItems (list) --
              • (dict) --
                • type (string) --
                • value (bytes) --
            • timeline (dict) --
              • start (datetime) --
              • estimatedFinish (datetime) --
              • actualFinish (datetime) --