Amazon WorkLink

Adds or overwrites one or more tags for the specified resource, such as a fleet. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the fleet.

type Tags:

dict

param Tags:

[REQUIRED]

The tags to add to the resource. A tag is a key-value pair.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Retrieves a list of tags for the specified resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the fleet.

rtype:

dict

returns:

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • Tags (dict) --

    The tags attached to the resource. A tag is a key-value pair.

    • (string) --

      • (string) --

Removes one or more tags from the specified resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

type ResourceArn:

string

param ResourceArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the fleet.

type TagKeys:

list

param TagKeys:

[REQUIRED]

The list of tag keys to remove from the resource.

• (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

{'Tags': {'string': 'string'}}

Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app.

See also: AWS API Documentation

Request Syntax

client.create_fleet(
    FleetName='string',
    DisplayName='string',
    OptimizeForEndUserLocation=True|False,
    Tags={
        'string': 'string'
    }
)

type FleetName:

string

param FleetName:

[REQUIRED]

A unique name for the fleet.

type DisplayName:

string

param DisplayName:

The fleet name to display.

type OptimizeForEndUserLocation:

boolean

param OptimizeForEndUserLocation:

The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.

type Tags:

dict

param Tags:

The tags to add to the resource. A tag is a key-value pair.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'FleetArn': 'string'
}

Response Structure

• (dict) --

  • FleetArn (string) --

    The Amazon Resource Name (ARN) of the fleet.

{'Tags': {'string': 'string'}}

Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.

See also: AWS API Documentation

Request Syntax

client.describe_fleet_metadata(
    FleetArn='string'
)

type FleetArn:

string

param FleetArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the fleet.

rtype:

dict

returns:

Response Syntax

{
    'CreatedTime': datetime(2015, 1, 1),
    'LastUpdatedTime': datetime(2015, 1, 1),
    'FleetName': 'string',
    'DisplayName': 'string',
    'OptimizeForEndUserLocation': True|False,
    'CompanyCode': 'string',
    'FleetStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED_TO_CREATE'|'FAILED_TO_DELETE',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • CreatedTime (datetime) --

    The time that the fleet was created.

  • LastUpdatedTime (datetime) --

    The time that the fleet was last updated.

  • FleetName (string) --

    The name of the fleet.

  • DisplayName (string) --

    The name to display.

  • OptimizeForEndUserLocation (boolean) --

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.

  • CompanyCode (string) --

    The identifier used by users to sign in to the Amazon WorkLink app.

  • FleetStatus (string) --

    The current state of the fleet.

  • Tags (dict) --

    The tags attached to the resource. A tag is a key-value pair.

    • (string) --

      • (string) --

{'FleetSummaryList': {'Tags': {'string': 'string'}}}

Retrieves a list of fleets for the current account and Region.

See also: AWS API Documentation

Request Syntax

client.list_fleets(
    NextToken='string',
    MaxResults=123
)

type NextToken:

string

param NextToken:

The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

type MaxResults:

integer

param MaxResults:

The maximum number of results to be included in the next page.

rtype:

dict

returns:

Response Syntax

{
    'FleetSummaryList': [
        {
            'FleetArn': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'FleetName': 'string',
            'DisplayName': 'string',
            'CompanyCode': 'string',
            'FleetStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED'|'FAILED_TO_CREATE'|'FAILED_TO_DELETE',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • FleetSummaryList (list) --

    The summary list of the fleets.

    • (dict) --

      The summary of the fleet.

      • FleetArn (string) --

        The Amazon Resource Name (ARN) of the fleet.

      • CreatedTime (datetime) --

        The time when the fleet was created.

      • LastUpdatedTime (datetime) --

        The time when the fleet was last updated.

      • FleetName (string) --

        The name of the fleet.

      • DisplayName (string) --

        The name of the fleet to display.

      • CompanyCode (string) --

        The identifier used by users to sign into the Amazon WorkLink app.

      • FleetStatus (string) --

        The status of the fleet.

      • Tags (dict) --

        The tags attached to the resource. A tag is a key-value pair.

        • (string) --

          • (string) --

  • NextToken (string) --

    The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.