GameLiftStreams / Client / associate_applications

associate_applications

GameLiftStreams.Client.associate_applications(**kwargs)

When you associate, or link, an application with a stream group, then Amazon GameLift Streams can launch the application using the stream group’s allocated compute resources. The stream group must be in ACTIVE status. You can reverse this action by using DisassociateApplications.

See also: AWS API Documentation

Request Syntax

response = client.associate_applications(
    ApplicationIdentifiers=[
        'string',
    ],
    Identifier='string'
)
Parameters:

  • ApplicationIdentifiers (list) –

    [REQUIRED]

    A set of applications to associate with the stream group.

    This value is a set of either Amazon Resource Names (ARN) or IDs that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.

    • (string) –

  • Identifier (string) –

    [REQUIRED]

    A stream group to associate to the applications.

    This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationArns': [
        'string',
    ],
    'Arn': 'string'
}

Response Structure

  • (dict) –

    • ApplicationArns (list) –

      A set of applications that are associated to the stream group.

      This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

      • (string) –

    • Arn (string) –

      A stream group that is associated to the applications.

      This value is an Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4.

Exceptions