OpsWorks / Client / describe_layers

describe_layers

OpsWorks.Client.describe_layers(**kwargs)

Requests a description of one or more layers in a specified stack.

Note

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

See also: AWS API Documentation

Request Syntax

response = client.describe_layers(
    StackId='string',
    LayerIds=[
        'string',
    ]
)

Parameters:

• StackId (string) – The stack ID.

• LayerIds (list) –

  An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Layers': [
        {
            'Arn': 'string',
            'StackId': 'string',
            'LayerId': 'string',
            'Type': 'aws-flow-ruby'|'ecs-cluster'|'java-app'|'lb'|'web'|'php-app'|'rails-app'|'nodejs-app'|'memcached'|'db-master'|'monitoring-master'|'custom',
            'Name': 'string',
            'Shortname': 'string',
            'Attributes': {
                'string': 'string'
            },
            'CloudWatchLogsConfiguration': {
                'Enabled': True|False,
                'LogStreams': [
                    {
                        'LogGroupName': 'string',
                        'DatetimeFormat': 'string',
                        'TimeZone': 'LOCAL'|'UTC',
                        'File': 'string',
                        'FileFingerprintLines': 'string',
                        'MultiLineStartPattern': 'string',
                        'InitialPosition': 'start_of_file'|'end_of_file',
                        'Encoding': 'ascii'|'big5'|'big5hkscs'|'cp037'|'cp424'|'cp437'|'cp500'|'cp720'|'cp737'|'cp775'|'cp850'|'cp852'|'cp855'|'cp856'|'cp857'|'cp858'|'cp860'|'cp861'|'cp862'|'cp863'|'cp864'|'cp865'|'cp866'|'cp869'|'cp874'|'cp875'|'cp932'|'cp949'|'cp950'|'cp1006'|'cp1026'|'cp1140'|'cp1250'|'cp1251'|'cp1252'|'cp1253'|'cp1254'|'cp1255'|'cp1256'|'cp1257'|'cp1258'|'euc_jp'|'euc_jis_2004'|'euc_jisx0213'|'euc_kr'|'gb2312'|'gbk'|'gb18030'|'hz'|'iso2022_jp'|'iso2022_jp_1'|'iso2022_jp_2'|'iso2022_jp_2004'|'iso2022_jp_3'|'iso2022_jp_ext'|'iso2022_kr'|'latin_1'|'iso8859_2'|'iso8859_3'|'iso8859_4'|'iso8859_5'|'iso8859_6'|'iso8859_7'|'iso8859_8'|'iso8859_9'|'iso8859_10'|'iso8859_13'|'iso8859_14'|'iso8859_15'|'iso8859_16'|'johab'|'koi8_r'|'koi8_u'|'mac_cyrillic'|'mac_greek'|'mac_iceland'|'mac_latin2'|'mac_roman'|'mac_turkish'|'ptcp154'|'shift_jis'|'shift_jis_2004'|'shift_jisx0213'|'utf_32'|'utf_32_be'|'utf_32_le'|'utf_16'|'utf_16_be'|'utf_16_le'|'utf_7'|'utf_8'|'utf_8_sig',
                        'BufferDuration': 123,
                        'BatchCount': 123,
                        'BatchSize': 123
                    },
                ]
            },
            'CustomInstanceProfileArn': 'string',
            'CustomJson': 'string',
            'CustomSecurityGroupIds': [
                'string',
            ],
            'DefaultSecurityGroupNames': [
                'string',
            ],
            'Packages': [
                'string',
            ],
            'VolumeConfigurations': [
                {
                    'MountPoint': 'string',
                    'RaidLevel': 123,
                    'NumberOfDisks': 123,
                    'Size': 123,
                    'VolumeType': 'string',
                    'Iops': 123,
                    'Encrypted': True|False
                },
            ],
            'EnableAutoHealing': True|False,
            'AutoAssignElasticIps': True|False,
            'AutoAssignPublicIps': True|False,
            'DefaultRecipes': {
                'Setup': [
                    'string',
                ],
                'Configure': [
                    'string',
                ],
                'Deploy': [
                    'string',
                ],
                'Undeploy': [
                    'string',
                ],
                'Shutdown': [
                    'string',
                ]
            },
            'CustomRecipes': {
                'Setup': [
                    'string',
                ],
                'Configure': [
                    'string',
                ],
                'Deploy': [
                    'string',
                ],
                'Undeploy': [
                    'string',
                ],
                'Shutdown': [
                    'string',
                ]
            },
            'CreatedAt': 'string',
            'InstallUpdatesOnBoot': True|False,
            'UseEbsOptimizedInstances': True|False,
            'LifecycleEventConfiguration': {
                'Shutdown': {
                    'ExecutionTimeout': 123,
                    'DelayUntilElbConnectionsDrained': True|False
                }
            }
        },
    ]
}

Response Structure

• (dict) –

  Contains the response to a DescribeLayers request.

  • Layers (list) –

    An array of Layer objects that describe the layers.

    • (dict) –

      Describes a layer.

      • Arn (string) –

        The Amazon Resource Number (ARN) of a layer.

      • StackId (string) –

        The layer stack ID.

      • LayerId (string) –

        The layer ID.

      • Type (string) –

        The layer type.

      • Name (string) –

        The layer name. Layer names can be a maximum of 32 characters.

      • Shortname (string) –

        The layer short name.

      • Attributes (dict) –

        The layer attributes.

        For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, OpsWorks Stacks returns *****FILTERED***** instead of the actual value

        For an ECS Cluster layer, OpsWorks Stacks the EcsClusterArn attribute is set to the cluster’s ARN.

        • (string) –

          • (string) –

      • CloudWatchLogsConfiguration (dict) –

        The Amazon CloudWatch Logs configuration settings for the layer.

        • Enabled (boolean) –

          Whether CloudWatch Logs is enabled for a layer.

        • LogStreams (list) –

          A list of configuration options for CloudWatch Logs.

          • (dict) –

            Describes the CloudWatch Logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.

            • LogGroupName (string) –

              Specifies the destination log group. A log group is created automatically if it doesn’t already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, ‘_’ (underscore), ‘-’ (hyphen), ‘/’ (forward slash), and ‘.’ (period).

            • DatetimeFormat (string) –

              Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

            • TimeZone (string) –

              Specifies the time zone of log event time stamps.

            • File (string) –

              Specifies log files that you want to push to CloudWatch Logs.

              File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don’t use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

              Zipped files are not supported.

            • FileFingerprintLines (string) –

              Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as ‘1’, ‘2-5’. The default value is ‘1’, meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

            • MultiLineStartPattern (string) –

              Specifies the pattern for identifying the start of a log message.

            • InitialPosition (string) –

              Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

            • Encoding (string) –

              Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

            • BufferDuration (integer) –

              Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

            • BatchCount (integer) –

              Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

            • BatchSize (integer) –

              Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

      • CustomInstanceProfileArn (string) –

        The ARN of the default IAM profile to be used for the layer’s EC2 instances. For more information about IAM ARNs, see Using Identifiers.

      • CustomJson (string) –

        A JSON formatted string containing the layer’s custom stack configuration and deployment attributes.

      • CustomSecurityGroupIds (list) –

        An array containing the layer’s custom security group IDs.

        • (string) –

      • DefaultSecurityGroupNames (list) –

        An array containing the layer’s security group names.

        • (string) –

      • Packages (list) –

        An array of Package objects that describe the layer’s packages.

        • (string) –

      • VolumeConfigurations (list) –

        A VolumeConfigurations object that describes the layer’s Amazon EBS volumes.

        • (dict) –

          Describes an Amazon EBS volume configuration.

          • MountPoint (string) –

            The volume mount point. For example “/dev/sdh”.

          • RaidLevel (integer) –

            The volume RAID level.

          • NumberOfDisks (integer) –

            The number of disks in the volume.

          • Size (integer) –

            The volume size.

          • VolumeType (string) –

            The volume type. For more information, see Amazon EBS Volume Types.

            • standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

            • io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

            • gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

            • st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB.

            • sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB.

          • Iops (integer) –

            For PIOPS volumes, the IOPS per disk.

          • Encrypted (boolean) –

            Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.

      • EnableAutoHealing (boolean) –

        Whether auto healing is disabled for the layer.

      • AutoAssignElasticIps (boolean) –

        Whether to automatically assign an Elastic IP address to the layer’s instances. For more information, see How to Edit a Layer.

      • AutoAssignPublicIps (boolean) –

        For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer’s instances. For more information, see How to Edit a Layer.

      • DefaultRecipes (dict) –

        OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, OpsWorks Stacks runs a set of standard recipes for each event. You can also provide custom recipes for any or all layers and events. OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

        To specify a recipe, use the cookbook’s directory name in the repository followed by two colons and the recipe name, which is the recipe’s file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository’s phpapp2 folder.

        • Setup (list) –

          An array of custom recipe names to be run following a setup event.

          • (string) –

        • Configure (list) –

          An array of custom recipe names to be run following a configure event.

          • (string) –

        • Deploy (list) –

          An array of custom recipe names to be run following a deploy event.

          • (string) –

        • Undeploy (list) –

          An array of custom recipe names to be run following a undeploy event.

          • (string) –

        • Shutdown (list) –

          An array of custom recipe names to be run following a shutdown event.

          • (string) –

      • CustomRecipes (dict) –

        A LayerCustomRecipes object that specifies the layer’s custom recipes.

        • Setup (list) –

          An array of custom recipe names to be run following a setup event.

          • (string) –

        • Configure (list) –

          An array of custom recipe names to be run following a configure event.

          • (string) –

        • Deploy (list) –

          An array of custom recipe names to be run following a deploy event.

          • (string) –

        • Undeploy (list) –

          An array of custom recipe names to be run following a undeploy event.

          • (string) –

        • Shutdown (list) –

          An array of custom recipe names to be run following a shutdown event.

          • (string) –

      • CreatedAt (string) –

        Date when the layer was created.

      • InstallUpdatesOnBoot (boolean) –

        Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

        Note

        We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

      • UseEbsOptimizedInstances (boolean) –

        Whether the layer uses Amazon EBS-optimized instances.

      • LifecycleEventConfiguration (dict) –

        A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

        • Shutdown (dict) –

          A ShutdownEventConfiguration object that specifies the Shutdown event configuration.

          • ExecutionTimeout (integer) –

            The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before shutting down an instance.

          • DelayUntilElbConnectionsDrained (boolean) –

            Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining

Exceptions

• OpsWorks.Client.exceptions.ValidationException

• OpsWorks.Client.exceptions.ResourceNotFoundException