You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::DescribeAssociationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass DescribeAssociationRequest data as a hash:

{
  name: "DocumentName",
  instance_id: "InstanceId",
  association_id: "AssociationId",
  association_version: "AssociationVersion",
}

Instance Attribute Summary collapse

Instance Attribute Details

#association_idString

The association ID for which you want information.

Returns:

  • (String)


2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2379

class DescribeAssociationRequest < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version)
  include Aws::Structure
end

#association_versionString

Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListInstanceAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

Returns:

  • (String)


2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2379

class DescribeAssociationRequest < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version)
  include Aws::Structure
end

#instance_idString

The instance ID.

Returns:

  • (String)


2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2379

class DescribeAssociationRequest < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version)
  include Aws::Structure
end

#nameString

The name of the Systems Manager document.

Returns:

  • (String)


2379
2380
2381
2382
2383
2384
2385
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 2379

class DescribeAssociationRequest < Struct.new(
  :name,
  :instance_id,
  :association_id,
  :association_version)
  include Aws::Structure
end